diff --git a/doc/changes/dev/13774.other.rst b/doc/changes/dev/13774.other.rst new file mode 100644 index 00000000000..65d7df43157 --- /dev/null +++ b/doc/changes/dev/13774.other.rst @@ -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`_. \ No newline at end of file diff --git a/mne/stats/cluster_level.py b/mne/stats/cluster_level.py index eb887e74a7d..b2c8c4aad39 100644 --- a/mne/stats/cluster_level.py +++ b/mne/stats/cluster_level.py @@ -1239,6 +1239,10 @@ def permutation_cluster_test( Notes ----- %(threshold_clust_f_notes)s + 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. References ---------- @@ -1539,6 +1543,10 @@ def spatio_temporal_cluster_test( Notes ----- %(threshold_clust_f_notes)s + 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. References ----------