mne-tools / mne-tools/mne-python
ENH(`mne.Report`): add `section` parameters to `.add_raw`, `.add_epochs` and `.add_evoked`
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
Hi! Thanks for the amazing work on MNE-Python :)
I'm wondering if there's any reason the .add_raw, .add_epochs and .add_evoked methods of mne.Report don't support the section parameter supported by many other methods in the same class.
If there's no design reason why this option is omitted, would you accept a PR to add this parameter in all these places?
Thanks!
Describe your proposed implementation
Add the section parameter to the .add_raw, .add_epochs and .add_evoked methods of mne.Report (and potentially others that lack it?)
Describe possible alternatives
This would be a useful change because I want to group my report sections by run, and right now it's not possible (let me know if there's a workaround though!)
I guess the alternative is leaving the current methods as they are, but I'm not sure if there's any principled reason why they shouldn't be grouped into sections.
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 locating the mne.Report.add_raw, add_epochs, and add_evoked implementations and compare how other Report methods accept section. Check the existing Report tests for these methods and add coverage showing that section groups the resulting report entries; done means all three methods accept and honor the parameter consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend-api-design
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100