mne-tools · CarinaFo · Jun 14, 2024 · Jun 14, 2024 · Jun 14, 2024 · Jun 14, 2024
@@ -39,6 +39,8 @@ Non-parametric (clustering) resampling methods:
 .. autosummary::
    :toctree: ../generated/
 
+   ClusterResult
+   cluster_test
    combine_adjacency
    permutation_cluster_test
    permutation_cluster_1samp_test

@@ -0,0 +1 @@
+Add new API for cluster permutation statistics of sensor data: :func:`mne.stats.cluster_test`, see the tutorial :ref:`tut-new-cluster-test-api`, by `Carina Forster`_, `Sophie Herbst`_, :newcontrib:`Maximilien Chaumon`, and `Scott Huberty`_.
@@ -297,6 +297,7 @@
 .. _Matti Toivonen: https://github.com/mattitoi
 .. _Maureen Shader: https://github.com/mshader
 .. _Mauricio Cespedes Tenorio: https://github.com/mcespedes99
+.. _Maximilien Chaumon: https://github.com/dnacombo
 .. _Melih Yayli: https://github.com/yaylim
 .. _Michael Krause: https://github.com/octomike
 .. _Michael Straube: https://github.com/mistraube

@@ -326,6 +326,7 @@
     "RawPersyst": "mne.io.Raw",
     "RawSNIRF": "mne.io.Raw",
     "Calibration": "mne.preprocessing.eyetracking.Calibration",
+    "ClusterResult": "mne.stats.ClusterResult",
     # dipy
     "dipy.align.AffineMap": "dipy.align.imaffine.AffineMap",
     "dipy.align.DiffeomorphicMap": "dipy.align.imwarp.DiffeomorphicMap",

@@ -15,6 +15,7 @@ dependencies:
   - eeglabio
   - ffmpeg ==8.1.2
   - filelock >=3.18.0
+  - formulaic
   - h5io >=0.2.4
   - h5py >=2.4
   - imageio >=2.6.1

diff --git a/mne/datasets/config.py b/mne/datasets/config.py
@@ -88,7 +88,7 @@
 # here: ↓↓↓↓↓↓↓↓
 RELEASES = dict(
     testing="0.176",
-    misc="0.27",
+    misc="0.30",
     phantom_kit="0.2",
     ucl_opm_auditory="0.2",
 )
@@ -129,7 +129,7 @@
 )
 MNE_DATASETS["misc"] = dict(
     archive_name=f"{MISC_VERSIONED}.tar.gz",  # 'mne-misc-data',
-    hash="md5:e343d3a00cb49f8a2f719d14f4758afe",
+    hash="md5:201d35531d3c03701cf50e38bb73481f",
     url=(
         f"https://codeload.github.com/mne-tools/mne-misc-data/tar.gz/{RELEASES['misc']}"
     ),

diff --git a/mne/stats/__init__.pyi b/mne/stats/__init__.pyi
@@ -1,9 +1,11 @@
 __all__ = [
+    "ClusterResult",
     "_ci",
     "_parametric_ci",
     "_st_mask_from_s_inds",
     "bonferroni_correction",
     "bootstrap_confidence_interval",
+    "cluster_test",
     "combine_adjacency",
     "erp",
     "f_mway_rm",
@@ -24,7 +26,9 @@ __all__ = [
 from . import erp
 from ._adjacency import combine_adjacency
 from .cluster_level import (
+    ClusterResult,
     _st_mask_from_s_inds,
+    cluster_test,
     permutation_cluster_1samp_test,
     permutation_cluster_test,
     spatio_temporal_cluster_1samp_test,
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Add new API for cluster permutation statistics of sensor data: :func:`mne.stats.cluster_test`, see the tutorial :ref:`tut-new-cluster-test-api`, by `Carina Forster`_, `Sophie Herbst`_, :newcontrib:`Maximilien Chaumon`, and `Scott Huberty`_.