pertpy 1.0.0

Perturbation Analysis in the scverse ecosystem.

pertpy - Perturbation Analysis in Python

Pertpy is a scverse ecosystem framework for analyzing large-scale single-cell perturbation experiments. It provides tools for harmonizing perturbation datasets, automating metadata annotation, calculating perturbation distances, and efficiently analyzing how cells respond to various stimuli like genetic modifications, drug treatments, and environmental changes.

Documentation

Please read the documentation for installation, tutorials, use cases, and more.

Installation

We recommend installing and running pertpy on a recent version of Linux (e.g. Ubuntu 24.04 LTS). No particular hardware beyond a standard laptop is required.

You can install pertpy in less than a minute via pip from PyPI:

pip install pertpy

or conda-forge:

conda install -c conda-forge pertpy

Differential gene expression

If you want to use the differential gene expression interface, please install pertpy by running:

pip install 'pertpy[de]'

tascCODA

if you want to use tascCODA, please install pertpy as follows:

pip install 'pertpy[tcoda]'

milo

milo requires either the "de" extra for the "pydeseq2" solver:

pip install 'pertpy[de]'

or, edger, statmod, and rpy2 for the "edger" solver:

BiocManager::install("edgeR")
BiocManager::install("statmod")

pip install rpy2

Citation

@article {Heumos2024.08.04.606516,
    author = {Heumos, Lukas and Ji, Yuge and May, Lilly and Green, Tessa and Zhang, Xinyue and Wu, Xichen and Ostner, Johannes and Peidli, Stefan and Schumacher, Antonia and Hrovatin, Karin and Müller, Michaela and Chong, Faye and Sturm, Gregor and Tejada, Alejandro and Dann, Emma and Dong, Mingze and Bahrami, Mojtaba and Gold, Ilan and Rybakov, Sergei and Namsaraeva, Altana and Moinfar, Amir and Zheng, Zihe and Roellin, Eljas and Mekki, Isra and Sander, Chris and Lotfollahi, Mohammad and Schiller, Herbert B. and Theis, Fabian J.},
    title = {Pertpy: an end-to-end framework for perturbation analysis},
    elocation-id = {2024.08.04.606516},
    year = {2024},
    doi = {10.1101/2024.08.04.606516},
    publisher = {Cold Spring Harbor Laboratory},
    URL = {https://www.biorxiv.org/content/early/2024/08/07/2024.08.04.606516},
    eprint = {https://www.biorxiv.org/content/early/2024/08/07/2024.08.04.606516.full.pdf},
    journal = {bioRxiv}
}

pertpy is part of the scverse® project (website, governance) and is fiscally sponsored by NumFOCUS. If you like scverse® and want to support our mission, please consider making a tax-deductible donation to help the project pay for developer time, professional services, travel, workshops, and a variety of other needs.