|PyPI| |Python Version| |License| |Read the Docs| |Build| |Tests| |Codecov| |pre-commit| |Black|


Welcome to spapros's documentation!
====================================

.. |PyPI| image:: https://img.shields.io/pypi/v/spapros.svg
   :target: https://pypi.org/project/spapros/
   :alt: PyPI
.. |Python Version| image:: https://img.shields.io/pypi/pyversions/spapros
   :target: https://pypi.org/project/spapros
   :alt: Python Version
.. |License| image:: https://img.shields.io/github/license/theislab/spapros
   :target: https://opensource.org/licenses/MIT
   :alt: License
.. |Read the Docs| image:: https://img.shields.io/readthedocs/spapros/latest.svg?label=Read%20the%20Docs
   :target: https://spapros.readthedocs.io/
   :alt: Read the documentation at https://spapros.readthedocs.io/
.. |Build| image:: https://github.com/theislab/spapros/workflows/Build%20spapros%20Package/badge.svg
   :target: https://github.com/theislab/spapros/workflows/Build%20spapros%20Package/badge.svg
   :alt: Build package Status
.. |Tests| image:: https://github.com/theislab/spapros/actions/workflows/run_tests.yml/badge.svg
   :target: https://github.com/theislab/spapros/actions/workflows/run_tests.yml/badge.svg
   :alt: Tests
.. |Codecov| image:: https://codecov.io/gh/theislab/spapros/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/theislab/spapros
   :alt: Codecov
.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
   :target: https://github.com/pre-commit/pre-commit
   :alt: pre-commit
.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :target: https://github.com/psf/black
   :alt: Black

|logo|


**Spapros** is a python package that provides a pipeline for probe set selection and evaluation for targeted spatial transcriptomics data.

Key Features
-------------

* Select probe sets for spatial transcriptomics which identify cell types of interest, capture general transcriptomic variation, and incorporate prior knowledge
* Evaluate probe sets with an extensive pipeline

.. toctree::
   :maxdepth: 1
   :caption: CONTENTS:
   :hidden:

   installation
   usage
   api
   tutorials
   authors
   code_of_conduct


Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


.. |logo| image:: https://user-images.githubusercontent.com/21954664/111175015-409d9080-85a8-11eb-9055-f7452aed98b2.png
.. _cookietemple: https://cookietemple.com
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _MIT: http://opensource.org/licenses/MIT
.. _PyPI: https://pypi.org/
.. _Hypermodern_Python_Cookiecutter: https://github.com/cjolowicz/cookiecutter-hypermodern-python
.. _pip: https://pip.pypa.io/
.. _Contributor Guide: CONTRIBUTING.rst
.. _Usage: https://spapros.readthedocs.io/en/latest/usage.html