Infer regulatory modules through informative latent component model in the single-cell Perturb-seq data
Project description
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
perturbviuses 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 installperturbviusingpipin 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file perturbvi-0.1.6.tar.gz.
File metadata
- Download URL: perturbvi-0.1.6.tar.gz
- Upload date:
- Size: 25.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.4.17
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7e8a7d183743361a631ff8f14b97d6a1fd13bf72e3034ccbb20ae515a04208e6
|
|
| MD5 |
a3752e1098bd45226197889dcbc2a030
|
|
| BLAKE2b-256 |
10f295d336074eaf92b8cfdbe0f43f2b8d2efcd63d5b8e357581b38866875d86
|
File details
Details for the file perturbvi-0.1.6-py3-none-any.whl.
File metadata
- Download URL: perturbvi-0.1.6-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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e227313ec8c758759472e9ccde5a58ae43489d39055843e974a78748c9a5ba69
|
|
| MD5 |
8132c8c5310a7336cb96ed416f5eaf07
|
|
| BLAKE2b-256 |
22909ef817fc7d6f4669a5183e65b24d072f4b165fb71f7669a362b9c7555ce6
|