.. _api_ref:

.. currentmodule:: ddmra

###
API
###


.. _api_workflows_ref:

****************************************
:mod:`ddmra.workflows`: Common workflows
****************************************

.. automodule:: ddmra.workflows
   :no-members:
   :no-inherited-members:

.. currentmodule:: ddmra.workflows

.. autosummary::
   :template: function.rst
   :toctree: generated/

   ddmra.workflows.run_analyses
   ddmra.workflows.run_pipeline_comparison


.. _api_analysis_ref:

*****************************************
:mod:`ddmra.analysis`: Analysis functions
*****************************************

.. automodule:: ddmra.analysis
   :no-members:
   :no-inherited-members:

.. currentmodule:: ddmra.analysis

.. autosummary::
   :template: function.rst
   :toctree: generated/

   ddmra.analysis.scrubbing_analysis
   ddmra.analysis.highlow_analysis
   ddmra.analysis.qcrsfc_analysis
   ddmra.analysis.qcrsfc_summary


.. _api_plotting_ref:

**************************************************
:mod:`ddmra.plotting`: Figure generation functions
**************************************************

.. automodule:: ddmra.plotting
   :no-members:
   :no-inherited-members:

.. currentmodule:: ddmra.plotting

.. autosummary::
   :toctree: generated/
   :template: function.rst

   ddmra.plotting.plot_analysis
   ddmra.plotting.plot_results


.. _api_filter_ref:

****************************************
:mod:`ddmra.filter`: Filtering functions
****************************************

.. automodule:: ddmra.filter
   :no-members:
   :no-inherited-members:

.. currentmodule:: ddmra.filter

.. autosummary::
   :toctree: generated/
   :template: module.rst

   ddmra.filter.filter_earl
   ddmra.filter.respiration_iirnotch


.. _api_utils_ref:

***************************************************
:mod:`ddmra.utils`: Miscellaneous utility functions
***************************************************

.. automodule:: ddmra.utils
   :no-members:
   :no-inherited-members:

.. currentmodule:: ddmra.utils

.. autosummary::
   :toctree: generated/
   :template: function.rst

   ddmra.utils.get_val
   ddmra.utils.null_to_p
   ddmra.utils.fast_pearson
   ddmra.utils.get_fd_power
   ddmra.utils.moving_average
   ddmra.utils.average_across_distances
   ddmra.utils.assess_significance