Skip to main content

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.

Metadata

Release files for crispat 0.9.11

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for crispat 0.9.11
File Size Uploaded Provenance
crispat-0.9.11.tar.gz 26.6 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for crispat 0.9.11
File Interpreter ABI Platform
crispat-0.9.11-py3-none-any.whl Python 3 none any Details

Total release size: 70.9 kB

Release files / crispat-0.9.11.tar.gz

Download URL crispat-0.9.11.tar.gz
Size 26.6 kB
Tags Source
SHA-256 checksum
How to use checksums
9f1a9ef714257f04827e27991799a3b4be13e3ac4122df3ffdca0b1f84920f42
BLAKE2b-256 checksum
How to use checksums
553e345fcb54d30b31631acb76ecc184e507fed6605da40a61edc9b39aa0af0a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.5

Release files / crispat-0.9.11-py3-none-any.whl

Download URL crispat-0.9.11-py3-none-any.whl
Size 44.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
31201dacfea6fe0f4bfdaa6d37a16896a7133e326a64be0c6d22a3f9d7683a52
BLAKE2b-256 checksum
How to use checksums
7880a6f327a125fa4e007c2e1209213ff793e13131ab6884d843d96be2172420
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.5

Security for crispat 0.9.11

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page