Skip to content

Commit bad37de

Browse files
committed
MRG: move note to public functions and add changelog
1 parent 265d1fc commit bad37de

2 files changed

Lines changed: 9 additions & 5 deletions

File tree

doc/changes/dev/13774.other.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
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`_.

mne/stats/cluster_level.py

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -909,11 +909,6 @@ def _permutation_cluster_test(
909909
Note. X is required to be a list. Depending on the length of X
910910
either a 1 sample t-test or an F test / more sample permutation scheme
911911
is elicited.
912-
Note: By default, the minimum number of
913-
neighboring points (e.g., channels)
914-
required to form a cluster is 0. This means
915-
a single significant point can technically
916-
constitute a cluster.
917912
"""
918913
_check_option("out_type", out_type, ["mask", "indices"])
919914
_check_option("tail", tail, [-1, 0, 1])
@@ -1248,6 +1243,10 @@ def permutation_cluster_test(
12481243
References
12491244
----------
12501245
.. footbibliography::
1246+
Note: By default, the minimum number of neighboring
1247+
points (e.g., channels) required to form a cluster is 0.
1248+
This means a single significant point can
1249+
technically constitute a cluster.
12511250
"""
12521251
stat_fun, threshold = _check_fun(X, stat_fun, threshold, tail, "between")
12531252
return _permutation_cluster_test(
@@ -1548,6 +1547,10 @@ def spatio_temporal_cluster_test(
15481547
References
15491548
----------
15501549
.. footbibliography::
1550+
Note: By default, the minimum number of neighboring
1551+
points (e.g., channels) required to form a cluster is 0.
1552+
This means a single significant point can
1553+
technically constitute a cluster.
15511554
"""
15521555
# convert spatial_exclude before passing on if necessary
15531556
if spatial_exclude is not None:

0 commit comments

Comments
 (0)