perturb-tools - Analysis Framework for Pooled CRISPR Genome Editing Screens.
Project description
perturb-tools is an analysis framework for pooled CRISPR genome-editing screens. Thus far, development has focused on local (i.e., not genome-wide) tiling screens with specific phenotypic readouts though expansion of this scope is of interest.
Data Structure and Analysis Framework
import perturb_tools as pt
screen = pt.Screen(X)
Genome Editing Screen composed of: n_guides x n_conditions = 946 x 12
guides: 'barcode', 'barcode_id', 'experiment', 'sequence', 'target_id', 'pred_ABE_edit', 'pred_CBE_edit'
samples: 'condition', 'replicate'
samples_m: 'barcode_counts', 'unexpected_sequences'
samples_p: 'correlation'
layers: 'X_lognorm'
uns: 'run_info', 'poolq3', 'metadata', 'SampleBarcodeReadCounts', 'CommonSampleBarcodeReadCounts'
This format and organization of metadata surrounding a multidimensional experiment is inspired by AnnData, a useful solution for the analogous organization of single-cell data.
The three main components of this data strcuture:
-
screen.X
(Numpy array) -
screen.samples
(pandas DataFrame) of shape:[n_samples x sample_annotation]
-
screen.guides
(pandas DataFrame) of shape:[n_guides x guide_annotation]
See the tutorial for more information.
Installation
Install the development package:
# (1) clone this repository
git clone https://github.com/pinellolab/perturb-tools.git
# (2) install the local project in editable mode
cd ./perturb-tools; pip install -e .
General analysis Steps
- See tutorial which includes:
- API tutorial
- Normalization
- Arithmetic
- Calculating the mean, standard deviation, and log-fold change between/across replicates
- Correlation calculation
- Hit discovery (under development)
- Visualization (under development)
Items under consideration:
-
Sequence prediction of targeted base-edit
-
TF motif annotation
a. Occupancy of Cas9 for CRISPRi (and how this may disrupt a TF motif)
b. Putative creation / destruction of TF motifs upon predicted base-editing outcome
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
Hashes for perturb_tools-0.2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c3d53c09d41daca3ba250a388c2e304fda70ca28318e57b3a4db6912133a2da2 |
|
MD5 | 4c5cef02b2b60de9e26bf10dd1280fb0 |
|
BLAKE2b-256 | 8087a304bb26231e89125f1df1e6cdbea21d83bfa6663cf5909e6abf97c7281b |