Skip to content

Commit dda5c4c

Browse files
committed
DOC: clarify that min neighbors for clusters is 0 in permutation_cluster_test
1 parent 6d49f69 commit dda5c4c

1 file changed

Lines changed: 3 additions & 0 deletions

File tree

mne/stats/cluster_level.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -909,6 +909,9 @@ 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 neighboring points (e.g., channels)
913+
required to form a cluster is 0. This means a single significant point can technically
914+
constitute a cluster.
912915
"""
913916
_check_option("out_type", out_type, ["mask", "indices"])
914917
_check_option("tail", tail, [-1, 0, 1])

0 commit comments

Comments
 (0)