Skip to main content

CRISPR guide assignment tool

Project description

logo

crispat: CRISPR guide assignment tool

Pooled single-cell CRISPR screens are a powerful tool for systematically gaining new insights into the functional consequences of genetic perturbations in high-throughput analyses. To allow for meaningful downstream analyses and biological insights about gene regulatory mechanisms from single-cell CRISPR screen experiments a first crucial step is guide assignment, where cells are assigned to specific guides and corresponding genetic targets. For this, thresholds on the measured gRNA counts per cell are used to distinguish between background contamination and the actual guide presence in a cell. However, lots of different guide assignment strategies and thresholds are used by different labs without any guidance on what model or threshold to choose when.

As demonstrated on low MOI CRISPRi screens in our paper Braunger et al, 2024 the choice of guide assignment strategy strongly influences the results, highlighting the need to choose a suitable strategy for the data at hand for a reliable and powerful analysis of the data. To help with this choice the crispat package implements 11 different assignment methods and facilitates their comparison.

Guide assignment methods

Methods include simple approaches such as a threshold on the UMI counts or assigning the gRNA with highest counts per cell, as well as more advanced models taking into account the variability per cell, the variability per gRNA, or both. Methods are grouped into 4 main categories based on the information that is used during assignment:

  • independent (ga_umi)
  • across gRNAs (ga_max, ga_ratio)
  • across cells (ga_gauss, ga_poisson_gauss)
  • across gRNAs and across cells (ga_2beta, ga_3beta, ga_poisson, ga_negative_binomial, ga_binomial, ga_quantiles)

For details on the individual methods please refer to our our paper Braunger et al, 2024.

Tools for method comparison

In addition to the guide assignment functions, the package includes some additional helper functions incl. for

  • data import (starting from either a csv file containing the gRNA count matrix or from the cellranger count output)
  • running and combining results from different guide assignment methods (combine_assignments, load_assignments)
  • visualization and comparison of different methods (plot_intersection_heatmap, plot_n_assigned_cells, tutorials)

For details on the downstream analysis and comparison on different guide assignments obtained by crispat take a look at our tutorial page on downstream analyses.

Installation

To install crispat, run pip install crispat (see PyPI page). To avoid dependency conflicts, we recommend to first create a new conda environment with python 3.10. (or higher) and then using pip install crispat. Alternatively, the current version of crispat can also be installed by cloning this repository and then running pip install . inside the crispat directory.

Getting started

An example use case of crispat is shown in the guide_assignment.ipynb script.

Tutorials on how to evaluate differences between methods for downstream analyses can be found in the tutorials/downstream_analyses directory.

Documentation

For details on individual functions in the package refer to the crispat documentation.

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

crispat-0.9.11.tar.gz (26.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

crispat-0.9.11-py3-none-any.whl (44.4 kB view details)

Uploaded Python 3

File details

Details for the file crispat-0.9.11.tar.gz.

File metadata

  • Download URL: crispat-0.9.11.tar.gz
  • Upload date:
  • Size: 26.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.5

File hashes

Hashes for crispat-0.9.11.tar.gz
Algorithm Hash digest
SHA256 9f1a9ef714257f04827e27991799a3b4be13e3ac4122df3ffdca0b1f84920f42
MD5 84f68725ae27cde6db11f2d6adb7094b
BLAKE2b-256 553e345fcb54d30b31631acb76ecc184e507fed6605da40a61edc9b39aa0af0a

See more details on using hashes here.

File details

Details for the file crispat-0.9.11-py3-none-any.whl.

File metadata

  • Download URL: crispat-0.9.11-py3-none-any.whl
  • Upload date:
  • Size: 44.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.5

File hashes

Hashes for crispat-0.9.11-py3-none-any.whl
Algorithm Hash digest
SHA256 31201dacfea6fe0f4bfdaa6d37a16896a7133e326a64be0c6d22a3f9d7683a52
MD5 4e20e5f0888d0fb3eb9c4e8db240d7f3
BLAKE2b-256 7880a6f327a125fa4e007c2e1209213ff793e13131ab6884d843d96be2172420

See more details on using hashes here.

Supported by

Image AWS Cloud computing and Security Sponsor Image Datadog Monitoring Image Depot Continuous Integration Image Fastly CDN Image Google Download Analytics Image Pingdom Monitoring Image Sentry Error logging Image StatusPage Status page