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

# install susiepca dependency
uv pip install susiepca@git+https://github.com/mancusolab/susiepca.git@main

# install perturbvi
uv pip install perturbvi

# help
perturbvi --help

Get Started with perturbvi

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

perturbvi <matrix> <guide> <z_dim> <l_dim> <tau> -o=<out_dir> --verbose

Arguments

  • matrix: Path to the experiment CSV file.
  • guide: Path to the guide CSV file.
  • z_dim: Number of latent factors, Z dim (12).
  • l_dim: Number of single effects, L dim (400).
  • tau: Residual precision, Tau (800).
  • out_dir: Specifies the output directory path.
  • --verbose: For logging (Optional).

Example Usage

perturbvi luhmes_exp.csv luhmes_G.csv 12 400 800 -o=results --verbose

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

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.5.tar.gz (25.3 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.5-py3-none-any.whl (29.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for perturbvi-0.1.5.tar.gz
Algorithm Hash digest
SHA256 a8abab0a7d8da881d0592db1811ae6d51a89890df059367261cd2f19e7d5e31b
MD5 37fac606e40da8e176916dab78609f8a
BLAKE2b-256 1aa090ab2111d238595516818bcdc2176644560d2565d9eea3607fcdaf8907df

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for perturbvi-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 84408e226218aec8e26ccb76394282cbdea0b67f71a3a6f39b3603845da4aad0
MD5 52570faeea5377310c39eec7c84ebc8c
BLAKE2b-256 2d08ce35d04db78e5322f3fe17de34fc3ab4e77f17934a5e1b8438721b100894

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