mne-tools / mne-tools/mne-python

ENH: Adding ITAB file reader

Open
#12,439 7 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

ENH
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:

  1. I noticed that data is included in another repo, should I open a PR also in this repo?
  2. Is there a size limit of the files?
  3. Is it better a file that includes all features implemented (and tested) or it is better a set of files?
  4. 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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.