Reorg retroicor.

Author: tsalo

phys2denoise/metrics/__init__.py

@@ -1,7 +1,7 @@
 """Metrics derived from physiological signals."""
 from .cardiac import crf, cardiac_phase
 from .chest_belt import rpv, env, rv, rrf, respiratory_phase
-from .retroicor import retroicor
+from .multimodal import retroicor
 
 __all__ = [
     "crf",

phys2denoise/metrics/retroicor.py phys2denoise/metrics/multimodal.pyphys2denoise/metrics/retroicor.py renamed to phys2denoise/metrics/multimodal.py

@@ -48,6 +48,11 @@ def retroicor(
     phase : array_like
         2D array of shape (n_scans, n_slices)
 
+    Notes
+    -----
+    RETROICOR regressors should be regressed from the imaging data *before*
+    any other preprocessing, including slice-timing correction and motion correction.
+
     References
     ----------
     *   Glover, G. H., Li, T. Q., & Ress, D. (2000).