mne-tools / mne-tools/mne-python
Add `read_epochs_fif` for consistency
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 3.5k
- Forks
- 1.6k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 100
Description
Currently, we have read_raw as a wrapper that auto-detects file formats and dispatches to the appropriate read_raw_* functions. In epoch land, this is not the case: read_epochs works only with FIFF files, but we also have read_epochs_eeglab, read_epochs_fieldtrip, and so on.
I think it would be worth to try to be more consistent here. As a first step, we could add an alias read_epochs_fif, which calls read_epochs.
If we wanted to go a step further, we could deprecate the current FIF-specific read_epochs and make it a generic epoch reader, just like we have for raw data.
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 comparing the existing read_epochs entry point with the read_raw wrapper and the read_epochs_eeglab and read_epochs_fieldtrip functions. Add the requested read_epochs_fif alias so it calls read_epochs, and confirm that the public epoch-reading API exposes the new name consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100