Permutation_test (1/4): add comments and docstring of the functions

doc_conf/api.rst

@@ -26,7 +26,8 @@ Functions
    knockoff_aggregation
    model_x_knockoff
    multivariate_1D_simulation
-   permutation_test_cv
+   permutation_test
+   permutation_test_pval
    reid
    standardized_svr
    zscore_from_pval

doc_conf/references.bib

@@ -179,6 +179,24 @@ @article{liuFastPowerfulConditional2021
   file = {/home/ahmad/Zotero/storage/8HRQZX3H/Liu et al. - 2021 - Fast and Powerful Conditional Randomization Testin.pdf;/home/ahmad/Zotero/storage/YFNDKN2B/2006.html}
 }
 
+@book{westfall1993resampling,
+  title={Resampling-based multiple testing: Examples and methods for p-value adjustment},
+  author={Westfall, Peter H and Young, S Stanley},
+  volume={279},
+  year={1993},
+  publisher={John Wiley \& Sons}
+}
+
+@article{hirschhorn2005genome,
+  title={Genome-wide association studies for common diseases and complex traits},
+  author={Hirschhorn, Joel N and Daly, Mark J},
+  journal={Nature reviews genetics},
+  volume={6},
+  number={2},
+  pages={95--108},
+  year={2005},
+  publisher={Nature Publishing Group UK London}
+}
 @article{gaonkar_deriving_2012,
 	title = {Deriving statistical significance maps for {SVM} based image classification and group comparisons},
 	volume = {15},
@@ -192,4 +210,4 @@ @article{gaonkar_deriving_2012
 	year = {2012},
 	pmid = {23285616},
 	pmcid = {PMC3703958},
-}
+}

examples/plot_fmri_data_example.py

@@ -52,15 +52,18 @@
 from sklearn.cluster import FeatureAgglomeration
 from sklearn.feature_extraction import image
 from sklearn.linear_model import Ridge
+from sklearn.svm import LinearSVR
 from sklearn.utils import Bunch
 
 from hidimstat.ada_svr import ada_svr
 from hidimstat.clustered_inference import clustered_inference
 from hidimstat.ensemble_clustered_inference import ensemble_clustered_inference
-from hidimstat.permutation_test import permutation_test, permutation_test_cv
+from hidimstat.permutation_test import permutation_test, permutation_test_pval
 from hidimstat.standardized_svr import standardized_svr
 from hidimstat.stat_tools import pval_from_scale, zscore_from_pval
 
+n_job = None
+
 
 #############################################################################
 # Function to fetch and preprocess Haxby dataset
@@ -151,19 +154,28 @@ def preprocess_haxby(subject=2, memory=None):
 
 SVR_permutation_test_inference = False
 if SVR_permutation_test_inference:
-    # We computed the regularization parameter by CV (C = 0.1)
-    pval_corr_svr_perm_test, one_minus_pval_corr_svr_perm_test = permutation_test_cv(
-        X, y, n_permutations=50, C=0.1
+    # It will be better to associate cross validation with the estimator
+    # but for a sake of time, this is not done.
+    estimator = LinearSVR()
+    weight_svr, weight_svr_distribution = permutation_test(
+        X, y, estimator, n_permutations=50
+    )
+    pval_corr_svr_perm_test, one_minus_pval_corr_svr_perm_test = permutation_test_pval(
+        weight_svr, weight_svr_distribution
     )
 
 # Another method is to compute the p-values by permutation test from the
 # Ridge decoder. The solution provided by this method should be very close to
 # the previous one and the computation time is much shorter: around 20 seconds.
-
+# We computed the parameter from a cross valisation (alpha = 0.0215)
+# It will be better to use RidgeCV but for a sake of time, this is not done.
 estimator = Ridge()
-pval_corr_ridge_perm_test, one_minus_pval_corr_ridge_perm_test = permutation_test(
+weight_ridge, weight_ridge_distribution = permutation_test(
     X, y, estimator=estimator, n_permutations=200
 )
+pval_corr_ridge_perm_test, one_minus_pval_corr_ridge_perm_test = permutation_test_pval(
+    weight_ridge, weight_ridge_distribution
+)
 
 #############################################################################
 # Now, let us run the algorithm introduced by Gaonkar et al. (c.f. References).
@@ -305,4 +317,4 @@ def plot_map(
 # (EnCluDL) seems realistic as we recover the visual cortex and do not make
 # spurious discoveries.
 
-show()
+# show()

pyproject.toml

@@ -80,4 +80,8 @@ where = ["src"]
 
 
 [tool.hatch.version]
-source = "vcs"
+source = "vcs"
+
+#pyproject.toml
+[tool.pytest.ini_options]
+addopts = "--ignore=src"   # ignore src directory

src/hidimstat/__init__.py

@@ -7,7 +7,7 @@
 from .knockoffs import model_x_knockoff
 from .multi_sample_split import aggregate_quantiles
 from .noise_std import group_reid, reid
-from .permutation_test import permutation_test_cv
+from .permutation_test import permutation_test, permutation_test_pval
 from .scenario import multivariate_1D_simulation
 from .standardized_svr import standardized_svr
 from .stat_tools import zscore_from_pval
@@ -34,7 +34,8 @@
     "knockoff_aggregation",
     "model_x_knockoff",
     "multivariate_1D_simulation",
-    "permutation_test_cv",
+    "permutation_test",
+    "permutation_test_pval",
     "reid",
     "standardized_svr",
     "zscore_from_pval",