Skip to main content

Infer regulatory modules through informative latent component model in the single-cell Perturb-seq data

Project description

Documentation-webpage PyPI-Server Github License Project generated with Hatch

perturbVI

perturbvi is a scalable approach to infer regulatory modules through informative latent component model in the single-cell Perturb-seq data.

Installation | Example | Notes | Version | Support | Other Software


Installation

Users can download the latest repository and then use pip:

git clone https://github.com/mancusolab/perturbvi.git
cd perturbvi
pip install .

Get Started with perturbvi

1. infer

Perform inference using SuSiE PCA to find the regulatory modules from CRISPR perturbation data

perturbvi infer <exp_csv> <guide_csv> <gene_symbol_csv> -o=output --verbose

Arguments

  • exp_csv: Path to the experiment CSV file.
  • guide_csv: Path to the guide CSV file.
  • -o=output: Specifies the output directory name or path.
  • --verbose: For logging (Optional).

Example Usage

perturbvi infer data/exp.csv data/guide.csv -o=data/out --verbose

This will save the all the output files (including the parameter file params.pkl) into the data/out folder, which can be used for the downstream tasks outlined below.

Notes

  • perturbvi uses JAX with Just In Time compilation to achieve high-speed computation. However, there are some issues for JAX with Mac M1 chip. To solve this, users need to initiate conda using miniforge, and then install perturbvi using pip in the desired environment.

Version History

TBD

Support

Please report any bugs or feature requests in the Issue Tracker. If users have any questions or comments, please contact Dong Yuan (dongyuan@usc.edu) and Nicholas Mancuso (nmancuso@usc.edu).

Other Software

Feel free to use other software developed by Mancuso Lab:

  • SuShiE: a Bayesian fine-mapping framework for molecular QTL data across multiple ancestries.
  • MA-FOCUS: a Bayesian fine-mapping framework using TWAS statistics across multiple ancestries to identify the causal genes for complex traits.
  • SuSiE-PCA: a scalable Bayesian variable selection technique for sparse principal component analysis
  • twas_sim: a Python software to simulate TWAS statistics.
  • FactorGo: a scalable variational factor analysis model that learns pleiotropic factors from GWAS summary statistics.
  • HAMSTA: a Python software to estimate heritability explained by local ancestry data from admixture mapping summary statistics.

perturbvi is distributed under the terms of the MIT license.


This project has been set up using Hatch. For details and usage information on Hatch see https://github.com/pypa/hatch.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

perturbvi-0.1.1.tar.gz (24.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

perturbvi-0.1.1-py3-none-any.whl (28.6 kB view details)

Uploaded Python 3

File details

Details for the file perturbvi-0.1.1.tar.gz.

File metadata

  • Download URL: perturbvi-0.1.1.tar.gz
  • Upload date:
  • Size: 24.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.4.17

File hashes

Hashes for perturbvi-0.1.1.tar.gz
Algorithm Hash digest
SHA256 d0327a506e35785e71eff316da513ca33b2ae64578371492af9ad4748e8c2b20
MD5 cf239a94242d1857ff7ac9ff77fad0fe
BLAKE2b-256 abdb28975d5224775f7b706257bc1d02c79039c167b097a4e12fa3378ce7208f

See more details on using hashes here.

File details

Details for the file perturbvi-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: perturbvi-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 28.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.4.17

File hashes

Hashes for perturbvi-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 31822e9d5e21ceb517261e68bbff21b93b9741615c48e0992e1fc52bfee72de4
MD5 814728a7a97907c1279a9599018af958
BLAKE2b-256 6d13e5e7dc0ad2c4d9fdf745f2acb65abb707b17d624c6ca0ff770e7bfb305a9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page