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.
  • gene_symbol_csv: Path to the gene symbol 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 data/symbol.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.0.tar.gz (24.5 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.0-py3-none-any.whl (28.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for perturbvi-0.1.0.tar.gz
Algorithm Hash digest
SHA256 b6b37f95040be712548503017a9f3d167f62748cab0143c00f15b7761733a2fe
MD5 35fdd840b993f98fa59efe108c8e4542
BLAKE2b-256 6df421735cc452a3d6c7bbbb699ff4a9a2c746384529c22e4b6642a076fea940

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for perturbvi-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fb4bef1815329ec562dd1e6cda7e3192f31e38ea7e8f1a6df950a22f29d71bb5
MD5 21915adb6ba05b7b2be182ca1213811b
BLAKE2b-256 6319893c85b6a5dd7d7a4564bf1b254f788f7f7af920763462e697566fd4d506

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