Skip to main content
MIRA https://badge.fury.io/py/mira-multiome.svg https://readthedocs.org/projects/mira-multiome/badge/?version=latest&style=plastic https://codeocean.com/codeocean-assets/badge/open-in-code-ocean.svg https://img.shields.io/conda/pn/liulab-dfci/mira-multiome https://zenodo.org/badge/DOI/10.1101/2021.12.06.471401.svg

Github | Website | Paper

Introduction

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 and Anndata to provide a rich, comprehensive framework integrating accessibility and expression data for more insights into your data. MIRA includes methods for:

  • Multimodal topic modeling

  • Construction a joint representation of cells

  • Regulator and functional enrichment

  • Pseudotime trajectory inference

  • Cis-regulatory modeling

  • Finding divergences between local chromatin accessibility and gene expression

... And more! For mora, check out the MIRA preprint on bioarxiv.

CODAL

CODAL is our new algorithm for batch effect correction. All MIRA topic models use the new CODAL algorithm for inference.

Documentation

See MIRA’s website for tutorials and API reference.

Data

https://raw.githubusercontent.com/AllenWLynch/MIRA/main/docs/source/_static/data_example.png

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.

Installation

MIRA can be installed from PyPI:

pip3 install mira-multiome

Installation will take about a minute. To set up an a new analysis, we recommend starting with a fresh environment:

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-env

To 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 to find the version of PyTorch that suits your system.

Learning Curve

https://raw.githubusercontent.com/AllenWLynch/MIRA/main/docs/source/_static/code_example.png

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

Metadata

Release files for mira-multiome 2.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mira-multiome 2.1.1
File Size Uploaded Provenance
mira-multiome-2.1.1.tar.gz 41.6 MB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for mira-multiome 2.1.1
File Interpreter ABI Platform
mira_multiome-2.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 42.3 MB

Release files / mira-multiome-2.1.1.tar.gz

Download URL mira-multiome-2.1.1.tar.gz
Size 41.6 MB
Tags Source
SHA-256 checksum
How to use checksums
f981bc40542097c3892cb02efca0c25766dfa0bbafcbd4e94ea18b3e5e27157b
BLAKE2b-256 checksum
How to use checksums
f47ce5bdbf07f2148ad494877f016ca644ef2e7cbadbfd32a38bc5c152056532
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.11.7

Release files / mira_multiome-2.1.1-py3-none-any.whl

Download URL mira_multiome-2.1.1-py3-none-any.whl
Size 662.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
49eb6d49f5ca8a8047c0e3ae8fdb78c94b3c0f40ed14763f54afe410de1db5c1
BLAKE2b-256 checksum
How to use checksums
c52686e887edb9ee9c9eb4d63776102bdba96ce9b3b5835a4aac8b91082b314c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.11.7

Security for mira-multiome 2.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release

2.1.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page