From 9b6a03c92781e2c7e6723ceef64d40c6fee1d6c1 Mon Sep 17 00:00:00 2001 From: Marie-Eve Picard Date: Thu, 8 Aug 2024 15:24:43 -0400 Subject: [PATCH] FIX typos and layout --- README.rst | 2 +- docs/api.rst | 8 ++++---- docs/installation.rst | 7 ++++++- docs/user_guide/metrics.rst | 2 +- 4 files changed, 12 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index d247555..4316096 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,7 @@ phys2denoise: A toolbox for physiological metrics calculation ============================================================= -This package is designed for use in the metrics calculation of physiological data, more specifically of cardiac and respiratory signals, to be used in fMRI denoising. +This package is designed for calculating physiological metrics, derived specifically cardiac and respiratory signals, to use in fMRI denoising. .. image:: https://readthedocs.org/projects/phys2denoise/badge/?version=latest diff --git a/docs/api.rst b/docs/api.rst index dde3b05..b419f38 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -5,13 +5,13 @@ API .. py:module:: phys2denoise Cardiac data ------------------- +------------ .. automodule:: phys2denoise.metrics.cardiac :members: heart_rate, heart_rate_variability, heart_beat_interval, cardiac_phase Respiratory data ------------- +---------------- .. automodule:: phys2denoise.metrics.chest_belt :members: respiratory_cariance_time, respiratory_pattern_variability, env, respiratory_variance, respiratory_phase @@ -22,13 +22,13 @@ Multimodal data .. autofunction:: phys2denoise.multimodal.retroicor Response functions ------------ +------------------ .. automodule:: phys2denoise.metrics.responses :members: crf, icrf, rrf Utilities ------------ +--------- .. automodule:: phys2denoise.metrics.utils :members: print_metric_call, mirrorpad_1d, rms_envelope_1d, apply_lags, apply_function_in_sliding_window, convolve_and_rescale, export_metric diff --git a/docs/installation.rst b/docs/installation.rst index a647649..8e5fe3a 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -16,8 +16,13 @@ and running the following: pip install phys2denoise +.. warning:: + + If you encounter an ImportError related to numpy.core.multiarray, please try to update + your matplotlib version to 3.9. + Developer installation --------------------- +---------------------- This package requires Python >= 3.6. Assuming you have the correct version of Python installed, you can install ``phys2denoise`` by opening a terminal and running diff --git a/docs/user_guide/metrics.rst b/docs/user_guide/metrics.rst index 7b1c5dc..e387600 100644 --- a/docs/user_guide/metrics.rst +++ b/docs/user_guide/metrics.rst @@ -64,7 +64,7 @@ For further information refer to the :py:mod:`physutils` documentation. Without using a Physio object ############################# -However, if the use of the ``Physio`` object of the :py:mod:`physutils` module is not preferred, the metrics can be also computed without it. The following +However, if the use of the ``Physio`` object from the :py:mod:`physutils` module is not preferred, the metrics can be also computed without it. The following example shows how to compute the heart rate and the heart rate variability using the :py:mod:`phys2denoise` package. .. code-block:: python