CRISPR guide assignment tool
Project description
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
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file crispat-0.9.10.tar.gz.
File metadata
- Download URL: crispat-0.9.10.tar.gz
- Upload date:
- Size: 25.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6a3db15266e2fc00ad1e5cf7ed1073e57c3e60d27a6476c28f4718705ca6f5bf
|
|
| MD5 |
0d47ace4ff39c6d823d104872d7bd70d
|
|
| BLAKE2b-256 |
713fb03edd95ee09ac27b09abe936622489b3680cc3b8669c44e1436e6cbbdc9
|
File details
Details for the file crispat-0.9.10-py3-none-any.whl.
File metadata
- Download URL: crispat-0.9.10-py3-none-any.whl
- Upload date:
- Size: 42.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c3704bf90116621501dbe3bf728037c43415204f723b1e6fe38c07cf00d78d15
|
|
| MD5 |
b8213f4ae42d4bedef036f60c8cdf564
|
|
| BLAKE2b-256 |
9f4d63c6f313e5d30bebe50ea40965d9bbae0b2cab1887343a4ef8f5e435286e
|