.. image:: https://raw.githubusercontent.com/AllenWLynch/MIRA/main/docs/source/_static/mira_logo.png :width: 400 :alt: MIRA :align: center
.. image:: https://badge.fury.io/py/mira-multiome.svg :target: https://badge.fury.io/py/mira-multiome
.. image:: https://readthedocs.org/projects/mira-multiome/badge/?version=latest&style=plastic
.. image:: https://codeocean.com/codeocean-assets/badge/open-in-code-ocean.svg :target: https://codeocean.com/capsule/6761625/tree
.. image:: https://img.shields.io/conda/pn/liulab-dfci/mira-multiome :target: https://anaconda.org/bioconda/mira-multiome
.. image:: https://zenodo.org/badge/DOI/10.1101/2021.12.06.471401.svg :target: https://www.nature.com/articles/s41592-022-01595-z
Github <https://github.com/cistrome/MIRA> | Website <https://mira-multiome.readthedocs.io/en/latest/> | Paper <https://www.biorxiv.org/content/10.1101/2021.12.06.471401v1.full.pdf>_
Multimodal models for Integrated Regulatory Analysis, or MIRA, is a python package for analyzing the dynamic processes of gene regulation using single-cell multiomics datasets.
MIRA works on top of Scanpy <https://scanpy.readthedocs.io/en/stable/> and Anndata <https://anndata.readthedocs.io/en/latest/>
to provide a rich, comprehensive framework integrating accessibility and expression data for more insights
into your data. MIRA includes methods for:
... And more! For mora, check out the MIRA preprint <https://www.biorxiv.org/content/10.1101/2021.12.06.471401v1.full.pdf>_ on bioarxiv.
CODAL <https://rdcu.be/dgCQF>_ is our new algorithm for batch effect correction. All MIRA topic models use the new CODAL algorithm for inference.
See MIRA's website <https://mira-multiome.readthedocs.io/>_ for tutorials and API reference.
.. image:: https://raw.githubusercontent.com/AllenWLynch/MIRA/main/docs/source/_static/data_example.png :width: 350 :align: center
MIRA takes count matrices from scRNA-seq, scATAC-seq, or scRNA-seq+scATAC-seq from a single-cell multiomics experiment, where each cell is measured using both assays, and measurements are linked by a shared cell barcode. We demonstrated MIRA using SHARE-seq data and commercial 10X genomics multiome data, but MIRA's assumptions and models are extensible to other multiome protocols.
MIRA can be installed from PyPI <https://pypi.org/project/mira-multiome>_:
.. code-block:: bash
pip3 install mira-multiomeInstallation will take about a minute. To set up an a new analysis, we recommend starting with a fresh environment:
.. code-block:: bash
conda create --name mira-env -c conda-forge -c pytorch -c bioconda scanpy jupyter leidenalg
conda activate mira-env
pip3 install mira-multiome
python -m ipykernel install --user --name mira-envTo use the environment in a jupyter notebook, start the notebook server, then go to Kernel > Change kernel > mira-env.
A conda distribution is coming soon.
Installing with GPU support
Training on a GPU reduces the training time of MIRA topic models.
To install MIRA with PyTorch compiled with GPU support, first install MIRA, as above. Then, follow instructions
at `pytorch.org <https://pytorch.org/get-started/locally/>`_ to find the version of PyTorch that suits your system.
Learning Curve
--------------
.. image:: https://raw.githubusercontent.com/AllenWLynch/MIRA/main/docs/source/_static/code_example.png
:width: 600
:align: center
If you have experience with Scanpy, we structured MIRA to follow similar conventions
so that it would feel familiar and intuitive. In fact, most MIRA analyses
seamlessly weave between MIRA and Scanpy functionalities for cleaning, slicing,
and plotting the data. In general, the first positional argument of a MIRA
function is an AnnData object, and the following keyword arguments change
how the function transforms that object.
Dependencies
------------
* pytorch
* pyro-ppl
* tqdm
* moods
* pyfaidx
* matplotlib
* lisa2
* requests
* networkx
* numpy
* scipy
* optuna
* anndata