mne-tools / mne-tools/mne-python
Add option for reporting rank somewhere in mne.Report
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 3.5k
- Forks
- 1.6k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 100
Description
Maybe in the covariance section, see https://github.com/mne-tools/mne-bids-pipeline/pull/1159 -- we ended up doing it as part of cov and just giving the rank as HTML. cc @hoechenberger who suggested this could be an upstream thing!
While looking at that PR, I noticed that add_covariance had no rank option, and neither did plot... might be something worth adding there, too, potentially. Not sure how but it's where you might want to have it indicated somewhere. Currently plot_covariance does its own thresholding to determine the rank... maybe we want to be able to replace that with one that's passed in 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 the covariance section of mne.Report, including add_covariance and its plot path, then compare the rank handling described in mne-bids-pipeline PR 1159. Determine whether rank should be displayed as HTML, accepted by add_covariance, passed to plot, or replace plot_covariance thresholding; done when the chosen behavior is implemented and covered by the relevant report or covariance checks.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data-visualization
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100