.. _api_documentation:

=================
API Documentation
=================

.. currentmodule:: borsar

Cluster-based tests
===================

.. currentmodule:: borsar.cluster

Classes

.. autosummary::
   :toctree: generated/

   Clusters

Functions

.. autosummary::
   :toctree: generated/

   read_cluster


Statistics
==========

.. currentmodule:: borsar.stats

Functions

.. autosummary::
   :toctree: generated/

   compute_regression_t
   format_pvalue


visualization
=============

.. currentmodule:: borsar.viz

Classes

.. autosummary::
   :toctree: generated/

   Topo


Current Source Density
======================

.. currentmodule:: borsar.csd

Functions

.. autosummary::
   :toctree: generated/

   current_source_density


Frequency space
===============

.. currentmodule:: borsar.freq

Functions

.. autosummary::
   :toctree: generated/

   compute_rest_psd


Utilities
=========

Functions

.. currentmodule:: borsar.utils

.. autosummary::
   :toctree: generated/

   find_index
   find_range
   get_info
   get_dropped_epochs
   silent_mne

   detect_overlap
   valid_windows
   create_fake_raw
   download_test_data