mne-tools / mne-tools/mne-python
ENH: Add param to report.add_epochs to report reject/flat
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 3.5k
- Forks
- 1.6k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 100
Description
I think the value of the "reject" parameter should be included via upstream changes to mne.Report.add_epochs().
Originally posted by @hoechenberger in https://github.com/mne-tools/mne-bids-pipeline/issues/839#issuecomment-1917498418
In other words, epochs.reject and maybe epochs.flat could be useful to allow opt-in to reporting in add_epochs so people know what rejection has been done. See linked PR for how it's done in MNE-BIDS-Pipeline for example.
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 reading MNE.Report.add_epochs and the MNE-BIDS-Pipeline example referenced in the issue, then inspect how epochs.reject and epochs.flat are represented. Done means add_epochs supports an opt-in way to report the rejection and flat criteria, with tests covering the resulting report.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100