Include a first BIDS dataset inheriting from `BaseBIDSDataset`
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.1k
- Forks
- 264
- Avg merge
- 1d 13m
- Merged PRs (30d)
- 23
Description
With the new class BaseBIDSDataset (see #724), it becomes easier to include BIDS datasets in moabb.
To further facilitate their integration, we should
- integrate a first dataset which inherits from
BaseBIDSDataset(or modify one of the existing datasets) - present this first BIDS dataset as a "template" for integrating BIDS datasets in moabb. Probably add a pointer to it in the docstring of
BaseBIDSDataset. Maybe even add a tutorial?
The goal of this issue is to make it as straightforward as possible for new contributors to add new BIDS datasets in MOABB
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the BaseBIDSDataset class from #724 and inspect the first integrated dataset that inherits from it. Document that dataset as the BIDS integration template, add a pointer from the BaseBIDSDataset docstring, and determine whether a tutorial is needed; the issue is done when new contributors have a clear example to follow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100