mne-tools / mne-tools/mne-python
DOC: Check consistency between docstring and tutorial for paired permutation cluster test
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 3.5k
- Forks
- 1.6k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 100
Description
Proposed documentation enhancement
This tutorial Mass-univariate twoway repeated measures ANOVA on single trial power — MNE 1.10.1 documentation gave an example that puts number of replications/subjects as the first dimension, akin to 1), but the API doc mne.stats.permutation_cluster_test — MNE 1.10.1 documentation tells me I should take after 2)? If I'm not mistaken one of these documentations needs revision right?
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
Compare the linked paired permutation cluster test tutorial with the linked mne.stats.permutation_cluster_test API documentation, focusing on the stated first dimension and replication/subject ordering. Determine which description is inconsistent, update the relevant documentation, and verify that both references describe the same input convention.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100