Welcome to niseq's documentation!
=================================

Below is the API documentation for the niseq Python package. Check out our `GitHub repository <https://github.com/john-veillette/niseq>`_ and `example notebooks <https://github.com/john-veillette/niseq/tree/main/notebooks>`_ for more information.

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

Cluster-level Tests
==================

.. automodule:: niseq.cluster_test
    :members:

Max-type Tests
==================

.. automodule:: niseq.max_test
    :members:

Alpha Spending Functions
==================

.. automodule:: niseq.spending_functions
    :members:
    :special-members: __init__, __call__
    :inherited-members:

Power Analysis
==================

.. automodule:: niseq.power.bootstrap
    :members:

Backend Functions
==================

.. automodule:: niseq._permutation
    :members:


.. toctree::
   :maxdepth: 2
   :caption: Contents: