mne-tools / mne-tools/mne-python
DOC: show example code for custom reader functions (was: Subclassing BaseRaw is too difficult)
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 3.5k
- Forks
- 1.6k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 100
Description
I directly set this [filenames] attribute [...] because I find setting up a new reader by adding a new class a bit cumbersome. I mostly do the file-specific stuff and then create a
RawArray, so maybe adding a public setter in that class might be an option?
Originally posted by @cbrnr in https://github.com/mne-tools/mne-python/issues/12843#issuecomment-2352441225
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 by locating the documentation for custom reader functions and the BaseRaw and RawArray classes. Add a clear example showing the intended custom-reader workflow, and consider the request complete when a newcomer can follow the example without needing to infer how those classes are connected.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100