Skip to main content

perturb-tools - Analysis Framework for Pooled CRISPR Genome Editing Screens.

Project description

perturb-tools_logo

PyPI pyversions PyPI version Code style: black

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:

  1. Sequence prediction of targeted base-edit

  2. 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

perturb_tools-0.3.5.tar.gz (38.6 kB view details)

Uploaded Source

Built Distribution

perturb_tools-0.3.5-py3-none-any.whl (57.5 kB view details)

Uploaded Python 3

File details

Details for the file perturb_tools-0.3.5.tar.gz.

File metadata

  • Download URL: perturb_tools-0.3.5.tar.gz
  • Upload date:
  • Size: 38.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.4

File hashes

Hashes for perturb_tools-0.3.5.tar.gz
Algorithm Hash digest
SHA256 aac2c58e696fe915bcd3abb097085e42fda70ac7f7d62e69519c1e65e9a6bdb7
MD5 96dafed36edfadfe282133cfe0990925
BLAKE2b-256 4d175af26f25a6858608ac48bb6b2ca23f1881177b87b6ae4ed78675a257afd4

See more details on using hashes here.

File details

Details for the file perturb_tools-0.3.5-py3-none-any.whl.

File metadata

File hashes

Hashes for perturb_tools-0.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 ed3e7509c7bea20edda56ef9d158073f2f21d7938bfc92a2bcf39915bc0f95eb
MD5 85e422d75aa1cbaa861094335b1c73ba
BLAKE2b-256 d6c6ebcaa3c7d42a7c8cf16bc229d2b14d26dfe2dfb6a58f49a9ef7bcfa6e70e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page