mne-tools / mne-tools/mne-python
Consistency in plot_topomap APIs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 3.5k
- Forks
- 1.6k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 100
Description
The evoked.plot_topomap function has parameters times and average to specify the times and range to average over:
https://github.com/mne-tools/mne-python/blob/master/mne/evoked.py#L333
At the same time, the plot_topomap method in AverageTFR has parameters tmin and tmax:
https://github.com/mne-tools/mne-python/blob/master/mne/time_frequency/tfr.py#L1279
Talking with @jona-sassenhagen, I guess these two APIs should be uniformised?
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 plot_topomap APIs in mne/evoked.py around line 333 and mne/time_frequency/tfr.py around line 1279. Review the existing discussion to determine which parameter scheme should be canonical; the work is done when the two APIs have an agreed, consistent interface.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data-visualization
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100