mne-tools / mne-tools/mne-python
ENH: Adding ITAB file reader
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 3.5k
- Forks
- 1.6k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 100
Description
Describe the new feature or enhancement
We would like to add the ITAB raw file reader to MNE-Python. @vpizzella made a first draft of the reader and I am prepping it following your guidelines with tests and linting.
I have a bunch of question regarding the management of testing data and tests:
- I noticed that data is included in another repo, should I open a PR also in this repo?
- Is there a size limit of the files?
- Is it better a file that includes all features implemented (and tested) or it is better a set of files?
- I used a matlab (fieldtrip) file to test whether the reader reads the same numbers, is it correct or is there any other strategy?
Describe your proposed implementation
A first draft of the implementation can be found here, but it needs linting and so on.
Describe possible alternatives
We followed other readers implementation, so it is similar to other readers and maybe optimal.
Additional context
No response
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 reviewing the draft reader in mne/io/itab and comparing it with the other reader implementations referenced in the issue. Clarify the testing-data repository, file-size, fixture, and MATLAB/FieldTrip validation questions before proceeding. Done means the ITAB reader is linted and covered by tests using appropriate test data.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100