DeMapper
==============

Welcome to DeMapper Toolbox

Usage:
------

:doc:`simple`
   Simplest entrypoint to running Mapper in MATLAB.

:doc:`mapper`
   Details on Mapper implementation. Check :doc:`Tutorial 1<tutorial1>` for a step-by-step guide to using Mapper as a library.

:doc:`batch`
   The Toolbox that helps you run multiple Mapper configurations on multiple subjects. Check :doc:`Tutorial 2<tutorial2>` for a step-by-step guide to using the CLI commands. Or check :doc:`Tutorial 3<tutorial3>` for its application on an fMRI dataset.
   
:doc:`extend`
   Documentation on extending the functionality of Mapper or the Toolbox to your specific usecase

Tutorials:
----------

:doc:`tutorial1`
   A step-by-step guide to using DeMapper Toolbox as a library

:doc:`tutorial2`
   A guide to using DeMapper CLI to run multiple Mappers on one dataset of multiple participants.

:doc:`tutorial3`
   A guide to using DeMapper on an functional MRI dataset.

:doc:`tutorial4`
   Links to further applications of DeMapper, including how to generate the figures for Hasegan et al., 2024.

.. Hidden TOCs

.. toctree::
   :maxdepth: 2
   :caption: Usage:
   :hidden:

   simple
   mapper
   batch
   extend

.. toctree::
   :maxdepth: 2
   :caption: Tutorials:
   :hidden:

   tutorial1
   tutorial2
   tutorial3
   tutorial4

.. toctree::
   :maxdepth: 2
   :caption: Documentation:
   :hidden:

   installation
   changelog
   genindex
   Code on GitHub ⎘ <https://github.com/braindynamicslab/demapper>
   Lab Website ⎘ <https://braindynamicslab.github.io/>