Bayesian variant Effect Inference with Guide counts and Editing outcome.
This is a generative-model-based CRISPR screen analysis software for that can account for
- :bar_chart: Multiple FACS sorting bins
- :waning_gibbous_moon: Incomplete editing rate
- :mag: Multiple target variant/bystander edit (under development)
BEIGE models the cellular phenotype of CRISPR sorting screen data as mixture distribution. The cells will be sorted based on the theoretical quantile based on (unperturbed) control distribution and your FACS sorting quantiles. The sorted samples (red box in below schematic) are sequenced to produce the final guide counts.
Its inference uses SVI (Stochastic Variational Inference) through Pyro to fit the posterior phenotype distribution of target element perturbation.
Installation
pip install beret-beige
Usage
CRISPR screen data without reporter information
beige myScreen.h5ad --prefix=my_analysis [--fit-pi|--perfect-edit|--guide_activity_column]
myScreen.h5ad must be formatted in Screen object in perturb-tools package.
If you don't have reporter information measured, you can take one of three options for analysis:
--fit-pi: Editing rate is fitted so that overall likelihood of the model is maximized.--perfect-edit: Assuming editing rate is 1 for all guides. This option is recommended over 1) based on the inference accuracy in simulation data.--guide_activity_column=your_col_name: If you want to use external information about guide activity estimated using other software, input the guide activity in the Screen.guides DataFrame (seeScreenobject in perturb-tools).Pass the column name as the argument.(under development)
CRISPR screen data with reporter information
beige myReporterScreen.h5ad --prefix=my_analysis [--rep-pi]
myReporterScreen.h5ad must be formatted in ReporterScreen object in beret package.
--rep-pi: If you suspect your biological replicate will have overall different level of editing rates, you can let the model to fit the replicate specific scaling factor of editing rate using this option.
Caveat
BEIGE assumes the phenotype distribution pre-sort sample is the same as the negative control. Whereas this assumption can be safely considered as true in case of variant screens, this may not hold true if you expect large phenotypical shift for the majority of perturbed elements.
Metadata
Release files for beret-beige 0.0.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| beret-beige-0.0.6.tar.gz | 14.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| beret_beige-0.0.6-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 28.6 kB
Release files / beret-beige-0.0.6.tar.gz
| Download URL | beret-beige-0.0.6.tar.gz |
|---|---|
| Size | 14.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
cd57b8c9f257a6a60c05335bea8ebf50b9fc0a93162716fa1159a3d2f1fd6a04
|
|
BLAKE2b-256 checksum How to use checksums |
9fad33a5f3efe5b43182263efb3dc2a6d4f4393db04c42e55828f9c52c6653a6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.8.6
|
Release files / beret_beige-0.0.6-py3-none-any.whl
| Download URL | beret_beige-0.0.6-py3-none-any.whl |
|---|---|
| Size | 13.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
07fd762a0dd41f3e4eeee8c5af95d6b486896e4bc81ca0ecf49468ecda0894a1
|
|
BLAKE2b-256 checksum How to use checksums |
27533c88e4ffb41bb3bcb596be44b6ea97c6bc3cfc46e45bc0b2fe499b345d2b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.8.6
|