Skip to content

DOC: clarify that min neighbors for clusters is 0 in permutation_clus… #13774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
athishdresu wants to merge 10 commits into
base: main
Choose a base branch
from
+9 −0
Open

DOC: clarify that min neighbors for clusters is 0 in permutation_clus… #13774

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
dda5c4c
DOC: clarify that min neighbors for clusters is 0 in permutation_clus…
athishdresu Mar 21, 2026
f8a9bea
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Mar 21, 2026
a68e8ec
FIX: break long line to pass ruff linting
athishdresu Mar 22, 2026
facf42a
FIX: resolve merge conflict and final linting
athishdresu Mar 22, 2026
265d1fc
Merge branch 'main' into main
athishdresu Mar 23, 2026
bad37de
MRG: move note to public functions and add changelog
athishdresu Mar 24, 2026
de1737f
Merge branch 'main' into main
athishdresu Mar 28, 2026
9cfe0e9
Merge branch 'main' into main
athishdresu Mar 31, 2026
60677d8
DOC: move notes to correct section
athishdresu Mar 31, 2026
12ab11d
Merge branch 'main' of https://github.com/athishdresu/mne-python
athishdresu Mar 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/changes/dev/13774.other.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- Clarify that the default minimum number of neighbors for clusters is 0 in :func:`mne.stats.permutation_cluster_test` and :func:`mne.stats.spatio_temporal_cluster_test`, by `Athish M`_.
8 changes: 8 additions & 0 deletions mne/stats/cluster_level.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1243,6 +1243,10 @@ def permutation_cluster_test(
References
----------
.. footbibliography::
Note: By default, the minimum number of neighboring
points (e.g., channels) required to form a cluster is 0.
This means a single significant point can
technically constitute a cluster.
Comment on lines +1242 to +1245
Copy link
Copy Markdown
Member

@drammock drammock Mar 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this note is in the References section. There's a "Notes" section right above.

"""
stat_fun, threshold = _check_fun(X, stat_fun, threshold, tail, "between")
return _permutation_cluster_test(
Expand Down Expand Up @@ -1543,6 +1547,10 @@ def spatio_temporal_cluster_test(
References
----------
.. footbibliography::
Note: By default, the minimum number of neighboring
points (e.g., channels) required to form a cluster is 0.
This means a single significant point can
technically constitute a cluster.
Comment on lines +1546 to +1549
Copy link
Copy Markdown
Member

@drammock drammock Mar 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't put notes in References section.

"""
# convert spatial_exclude before passing on if necessary
if spatial_exclude is not None:
Expand Down
Loading