The crisprScore
package provides R wrappers of several
on-target and off-target scoring methods for CRISPR guide RNAs (gRNAs).
The following nucleases are supported: SpCas9, AsCas12a, enAsCas12a, and
RfxCas13d (CasRx). The available on-target cutting efficiency scoring
methods are RuleSet1, RuleSet3, Azimuth, DeepHF, DeepSpCas9, DeepCpf1,
enPAM+GB, CRISPRscan and CRISPRater. Both the CFD and MIT scoring
methods are available for off-target specificity prediction. The package
also provides a Lindel-derived score to predict the probability of a
gRNA to produce indels inducing a frameshift for the Cas9 nuclease. Note
that DeepHF, DeepCpf1 and enPAM+GB are not available on Windows
machines.
Our work is described in a recent bioRxiv preprint: “The crisprVerse: A comprehensive Bioconductor ecosystem for the design of CRISPR guide RNAs across nucleases and technologies”
Our main gRNA design package crisprDesign
utilizes the crisprScore
package to add on- and off-target
scores to user-designed gRNAs; check out our Cas9
gRNA tutorial page to learn how to use crisprScore
via
crisprDesign
.
This package is supported for macOS, Linux and Windows machines. Some functionalities are not supported for Windows machines. Packages were developed and tested on R version 4.2.
crisprScore
can be installed from from the Bioconductor
devel branch using the following commands in a fresh R session:
Alternatively, the development version of crisprScore
and its dependencies can be installed by typing the following commands
inside of an R session:
install.packages("devtools")
library(devtools)
install_github("crisprVerse/crisprScoreData")
install_github("crisprVerse/crisprScore")
When calling one of the scoring methods for the first time after package installation, the underlying python module and conda environment will be automatically downloaded and installed without the need for user intervention. This may take several minutes, but this is a one-time installation. the first time after package installation.
Note that RStudio users will need to add the following line to their
.Rprofile
file in order for crisprScore
to
work properly:
We load crisprScore
in the usual way:
The scoringMethodsInfo
data.frame contains a succinct
summary of scoring methods available in crisprScore
:
## method nuclease left right type label len
## 1 ruleset1 SpCas9 -24 5 On-target RuleSet1 30
## 2 azimuth SpCas9 -24 5 On-target Azimuth 30
## 3 deephf SpCas9 -20 2 On-target DeepHF 23
## 4 lindel SpCas9 -33 31 On-target Lindel 65
## 5 mit SpCas9 -20 2 Off-target MIT 23
## 6 cfd SpCas9 -20 2 Off-target CFD 23
## 7 deepcpf1 AsCas12a -4 29 On-target DeepCpf1 34
## 8 enpamgb enAsCas12a -4 29 On-target EnPAMGB 34
## 9 crisprscan SpCas9 -26 8 On-target CRISPRscan 35
## 10 casrxrf CasRx NA NA On-target CasRx-RF NA
## 11 crisprai SpCas9 -19 2 On-target CRISPRai 22
## 12 crisprater SpCas9 -20 -1 On-target CRISPRater 20
## 13 deepspcas9 SpCas9 -24 5 On-target DeepSpCas9 30
## 14 ruleset3 SpCas9 -24 5 On-target RuleSet3 30
Each scoring algorithm requires a different contextual nucleotide
sequence. The left
and right
columns indicates
how many nucleotides upstream and downstream of the first nucleotide of
the PAM sequence are needed for input, and the len
column
indicates the total number of nucleotides needed for input. The
crisprDesign
(GitHub link)
package provides user-friendly functionalities to extract and score
those sequences automatically via the addOnTargetScores
function.
Predicting on-target cutting efficiency is an extensive area of
research, and we try to provide in crisprScore
the latest
state-of-the-art algorithms as they become available.
Different algorithms require different input nucleotide sequences to predict cutting efficiency as illustrated in the figure below.
The Rule Set 1 algorithm is one of the first on-target efficiency methods developed for the Cas9 nuclease (Doench et al. 2014). It generates a probability (therefore a score between 0 and 1) that a given sgRNA will cut at its intended target. 4 nucleotides upstream and 3 nucleotides downstream of the PAM sequence are needed for scoring:
flank5 <- "ACCT" #4bp
spacer <- "ATCGATGCTGATGCTAGATA" #20bp
pam <- "AGG" #3bp
flank3 <- "TTG" #3bp
input <- paste0(flank5, spacer, pam, flank3)
results <- getRuleSet1Scores(input)
The Azimuth score described below is an improvement over Rule Set 1 from the same lab.
The Azimuth algorithm is an improved version of the popular Rule Set 2 score for the Cas9 nuclease (Doench et al. 2016). It generates a probability (therefore a score between 0 and 1) that a given sgRNA will cut at its intended target. 4 nucleotides upstream and 3 nucleotides downstream of the PAM sequence are needed for scoring:
The Rule Set 3 is an improvement over Rule Set 1 and Rule Set 2/Azimuth developed for the SpCas9 nuclease, taking into account the type of tracrRNAs (DeWeirdt et al. 2022). Two types of tracrRNAs are currently offered:
GTTTTAGAGCTA-----GAAA-----TAGCAAGTTAAAAT... --> Hsu2013 tracrRNA
GTTTAAGAGCTATGCTGGAAACAGCATAGCAAGTTTAAAT... --> Chen2013 tracrRNA
Similar to Rule Set 1 and Azimuth, the input sequence requires 4 nucleotides upstream of the protospacer sequence, the protospacer sequence itself (20nt spacersequence and PAM sequence), and 3 nucleotides downstream of the PAM sequence:
flank5 <- "ACCT" #4bp
spacer <- "ATCGATGCTGATGCTAGATA" #20bp
pam <- "AGG" #3bp
flank3 <- "TTG" #3bp
input <- paste0(flank5, spacer, pam, flank3)
results <- getRuleSet3Scores(input, tracrRNA="Hsu2013")
A more involved version of the algorithm takes into account gene
context of the target protospacer sequence (Rule Set 3 Target) and will
be soon implemented in crisprScore
.
The DeepHF algorithm is an on-target cutting efficiency prediction algorithm for several variants of the Cas9 nuclease (Wang et al. 2019) using a recurrent neural network (RNN) framework. Similar to the Azimuth score, it generates a probability of cutting at the intended on-target. The algorithm only needs the protospacer and PAM sequences as inputs:
spacer <- "ATCGATGCTGATGCTAGATA" #20bp
pam <- "AGG" #3bp
input <- paste0(spacer, pam)
results <- getDeepHFScores(input)
Users can specify for which Cas9 they wish to score sgRNAs by using
the argument enzyme
: “WT” for Wildtype Cas9 (WT-SpCas9),
“HF” for high-fidelity Cas9 (SpCas9-HF), or “ESP” for enhancedCas9
(eSpCas9). For wildtype Cas9, users can also specify the promoter used
for expressing sgRNAs using the argument promoter
(“U6” by
default). See ?getDeepHFScores
for more details.
The DeepSpCas9 algorithm is an on-target cutting efficiency prediction algorithm for the SpCas9 nuclease (Kim et al. 2019). Similar to the Azimuth score, it generates a probability of cutting at the intended on-target. 4 nucleotides upstream of the protospacer sequence, and 3 nucleotides downstream of the PAM sequence are needed in top of the protospacer sequence for scoring:
flank5 <- "ACCT" #4bp
spacer <- "ATCGATGCTGATGCTAGATA" #20bp
pam <- "AGG" #3bp
flank3 <- "TTG" #3bp
input <- paste0(flank5, spacer, pam, flank3)
results <- getDeepSpCas9Scores(input)
spacer <- "ATCGATGCTGATGCTAGATA" #20bp
pam <- "AGG" #3bp
input <- paste0(spacer, pam)
results <- getDeepHFScores(input)
Users can specify for which Cas9 they wish to score sgRNAs by using
the argument enzyme
: “WT” for Wildtype Cas9 (WT-SpCas9),
“HF” for high-fidelity Cas9 (SpCas9-HF), or “ESP” for enhancedCas9
(eSpCas9). For wildtype Cas9, users can also specify the promoter used
for expressing sgRNAs using the argument promoter
(“U6” by
default). See ?getDeepHFScores
for more details.
The CRISPRscan algorithm, also known as the Moreno-Mateos score, is an on-target efficiency method for the SpCas9 nuclease developed for sgRNAs expressed from a T7 promoter, and trained on zebrafish data (Moreno-Mateos et al. 2015). It generates a probability (therefore a score between 0 and 1) that a given sgRNA will cut at its intended target. 6 nucleotides upstream of the protospacer sequence and 6 nucleotides downstream of the PAM sequence are needed for scoring:
The CRISPRater algorithm is an on-target efficiency method for the SpCas9 nuclease (Labuhn et al. 2018). It generates a probability (therefore a score between 0 and 1) that a given sgRNA will cut at its intended target. Only the 20bp spacer sequence is required.
The CRISPRai algorithm was developed by the Weissman lab to score
SpCas9 gRNAs for CRISPRa and CRISPRi applications (Horlbeck et al. 2016), for the human genome.
The function getCrispraiScores
requires several inputs.
First, it requires a data.frame specifying the genomic coordinates of the transcription starting sites (TSSs). An example of such a data.frame is provided in the crisprScore package:
## tss_id gene_symbol promoter transcripts position strand chr
## 1 A1BG_P1 A1BG P1 ENST00000596924 58347625 - chr19
## 2 A1BG_P2 A1BG P2 ENST00000263100 58353463 - chr19
## 3 KRAS_P1 KRAS P1 ENST00000311936 25250929 - chr12
## 4 SMARCA2_P1 SMARCA2 P1 ENST00000357248 2015347 + chr9
## 5 SMARCA2_P2 SMARCA2 P2 ENST00000382194 2017615 + chr9
## 6 SMARCA2_P3 SMARCA2 P3 ENST00000635133 2158470 + chr9
It also requires a data.frame specifying the genomic coordinates of the gRNA sequences to score. An example of such a data.frame is provided in the crisprScore package:
## grna_id tss_id pam_site strand spacer_19mer
## 1 A1BG_P1_1 A1BG_P1 58347601 - CTCCGGGCGACGTGGAGTG
## 2 A1BG_P1_2 A1BG_P1 58347421 - GGGCACCCAGGAGCGGTAG
## 3 A1BG_P1_3 A1BG_P1 58347624 - TCCACGTCGCCCGGAGCTG
## 4 A1BG_P1_4 A1BG_P1 58347583 - GCAGCGCAGGACGGCATCT
## 5 A1BG_P1_5 A1BG_P1 58347548 - AGCAGCTCGAAGGTGACGT
## 6 A1BG_P2_1 A1BG_P2 58353455 - ATGATGGTCGCGCTCACTC
All columns present in tssExampleCrispri
and
sgrnaExampleCrispri
are mandatory for
getCrispraiScores
to work.
Two additional arguments are required: fastaFile
, to
specify the path of the fasta file of the human reference genome, and
chromatinFiles
, which is a list of length 3 specifying the
path of files containing the chromatin accessibility data needed for the
algorithm in hg38 coordinates. The chromatin files can be downloaded
from Zenodo here. The
fasta file for the human genome (hg38) can be downloaded directly from
here: https://hgdownload.soe.ucsc.edu/goldenPath/hg38/bigZips/hg38.fa.gz
One can obtain the CRISPRai scores using the following command:
results <- getCrispraiScores(tss_df=tssExampleCrispri,
sgrna_df=sgrnaExampleCrispri,
modality="CRISPRi",
fastaFile="your/path/hg38.fa",
chromatinFiles=list(mnase="path/to/mnaseFile.bw",
dnase="path/to/dnaseFile.bw",
faire="oath/to/faireFile.bw"))
The function works identically for CRISPRa applications, with
modality replaced by CRISPRa
.
Different algorithms require different input nucleotide sequences to predict cutting efficiency as illustrated in the figure below.
The DeepCpf1 algorithm is an on-target cutting efficiency prediction algorithm for the Cas12a nuclease (Kim et al. 2018) using a convolutional neural network (CNN) framework. It generates a score between 0 and 1 to quantify the likelihood of Cas12a to cut for a given sgRNA. 4 nucleotides upstream of the PAM sequence, and 3 nucleotides downstream of the protospacer sequence are needed for scoring:
The enPAM+GB algorithm is an on-target cutting efficiency prediction algorithm for the enhanced Cas12a (enCas12a) nuclease (DeWeirdt et al. 2020) using a gradient-booster (GB) model. The enCas12a nuclease as an extended set of active PAM sequences in comparison to the wildtype Cas12 nuclease (Kleinstiver et al. 2019), and the enPAM+GB algorithm takes PAM activity into account in the calculation of the final score. It generates a probability (therefore a score between 0 and 1) of a given sgRNA to cut at the intended target. 4 nucleotides upstream of the PAM sequence, and 3 nucleotides downstream of the protospacer sequence are needed for scoring:
The CasRxRF method was developed to characterize on-target efficiency of the RNA-targeting nuclease RfxCas13d, abbreviated as CasRx (Wessels et al. 2020).
It requires as an input the mRNA sequence targeted by the gRNAs, and returns as an output on-target efficiency scores for all gRNAs targeting the mRNA sequence.
As an example, we predict on-target efficiency for gRNAs targeting
the mRNA sequence stored in the file test.fa
:
fasta <- file.path(system.file(package="crisprScore"),
"casrxrf/test.fa")
mrnaSequence <- Biostrings::readDNAStringSet(filepath=fasta
format="fasta",
use.names=TRUE)
results <- getCasRxRFScores(mrnaSequence)
Note that the function has a default argument
directRepeat
set to
aacccctaccaactggtcggggtttgaaac
, specifying the direct
repeat used in the CasRx construct (see (Wessels
et al. 2020).) The function also has an argument
binaries
that specifies the file path of the binaries for
three programs necessary by the CasRxRF algorithm:
RNAfold
: available as part of the ViennaRNA
packageRNAplfold
: available as part of the ViennaRNA
packageRNAhybrid
: available as part of the RNAhybrid
packageThose programs can be installed from their respective websites: VienneRNA and RNAhybrid.
If the argument is NULL
, the binaries are assumed to be
available on the PATH.
For CRISPR knockout systems, off-targeting effects can occur when the CRISPR nuclease tolerates some levels of imperfect complementarity between gRNA spacer sequences and protospacer sequences of the targeted genome. Generally, a greater number of mismatches between spacer and protospacer sequences decreases the likelihood of cleavage by a nuclease, but the nature of the nucleotide substitution can module the likelihood as well. Several off-target specificity scores were developed to predict the likelihood of a nuclease to cut at an unintended off-target site given a position-specific set of nucleotide mismatches.
We provide in crisprScore
two popular off-target
specificity scoring methods for CRISPR/Cas9 knockout systems: the MIT
score (Hsu et al. 2013) and the cutting
frequency determination (CFD) score (Doench et
al. 2016).
The MIT score was an early off-target specificity prediction algorithm developed for the CRISPR/Cas9 system (Hsu et al. 2013). It predicts the likelihood that the Cas9 nuclease will cut at an off-target site using position-specific mismatch tolerance weights. It also takes into consideration the total number of mismatches, as well as the average distance between mismatches. However, it does not take into account the nature of the nucleotide substitutions. The exact formula used to estimate the cutting likelihood is
$$\text{MIT} = \biggl(\prod_{p \in M}{w_p}\biggr)\times\frac{1}{\frac{19-d}{19}\times4+1}\times\frac{1}{m^2}$$
where M is the set of positions for which there is a mismatch between the sgRNA spacer sequence and the off-target sequence, wp is an experimentally-derived mismatch tolerance weight at position p, d is the average distance between mismatches, and m is the total number of mismatches. As the number of mismatches increases, the cutting likelihood decreases. In addition, off-targets with more adjacent mismatches will have a lower cutting likelihood.
The getMITScores
function takes as argument a character
vector of 20bp sequences specifying the spacer sequences of sgRNAs
(spacers
argument), as well as a vector of 20bp sequences
representing the protospacer sequences of the putative off-targets in
the targeted genome (protospacers
argument). PAM sequences
(pams
) must also be provided. If only one spacer sequence
is provided, it will reused for all provided protospacers.
The following code will generate MIT scores for 3 off-targets with
respect to the sgRNA ATCGATGCTGATGCTAGATA
:
spacer <- "ATCGATGCTGATGCTAGATA"
protospacers <- c("ACCGATGCTGATGCTAGATA",
"ATCGATGCTGATGCTAGATT",
"ATCGATGCTGATGCTAGATA")
pams <- c("AGG", "AGG", "AGA")
getMITScores(spacers=spacer,
protospacers=protospacers,
pams=pams)
## spacer protospacer score
## 1 ATCGATGCTGATGCTAGATA ACCGATGCTGATGCTAGATA 1.00000000
## 2 ATCGATGCTGATGCTAGATA ATCGATGCTGATGCTAGATT 0.41700000
## 3 ATCGATGCTGATGCTAGATA ATCGATGCTGATGCTAGATA 0.06944444
The CFD off-target specificity prediction algorithm was initially developed for the CRISPR/Cas9 system, and was shown to be superior to the MIT score (Doench et al. 2016). Unlike the MIT score, position-specific mismatch weights vary according to the nature of the nucleotide substitution (e.g. an A->G mismatch at position 15 has a different weight than an A->T mismatch at position 15).
Similar to the getMITScores
function, the
getCFDScores
function takes as argument a character vector
of 20bp sequences specifying the spacer sequences of sgRNAs
(spacers
argument), as well as a vector of 20bp sequences
representing the protospacer sequences of the putative off-targets in
the targeted genome (protospacers
argument).
pams
must also be provided. If only one spacer sequence is
provided, it will be used for all provided protospacers.
The following code will generate CFD scores for 3 off-targets with
respect to the sgRNA ATCGATGCTGATGCTAGATA
:
spacer <- "ATCGATGCTGATGCTAGATA"
protospacers <- c("ACCGATGCTGATGCTAGATA",
"ATCGATGCTGATGCTAGATT",
"ATCGATGCTGATGCTAGATA")
pams <- c("AGG", "AGG", "AGA")
getCFDScores(spacers=spacer,
protospacers=protospacers,
pams=pams)
## spacer protospacer score
## 1 ATCGATGCTGATGCTAGATA ACCGATGCTGATGCTAGATA 0.85714286
## 2 ATCGATGCTGATGCTAGATA ATCGATGCTGATGCTAGATT 0.60000000
## 3 ATCGATGCTGATGCTAGATA ATCGATGCTGATGCTAGATA 0.06944444
Non-homologous end-joining (NHEJ) plays an important role in double-strand break (DSB) repair of DNA. Error patterns of NHEJ can be strongly biased by sequence context, and several studies have shown that microhomology can be used to predict indels resulting from CRISPR/Cas9-mediated cleavage. Among other useful metrics, the frequency of frameshift-causing indels can be estimated for a given sgRNA.
Lindel (Chen et al. 2019) is a logistic
regression model that was trained to use local sequence context to
predict the distribution of mutational outcomes. In
crisprScore
, the function getLindelScores
return the proportion of “frameshifting” indels estimated by Lindel. By
chance, assuming a random distribution of indel lengths, frameshifting
proportions should be roughly around 0.66. A Lindel score higher than
0.66 indicates a higher than by chance probability that a sgRNA induces
a frameshift mutation.
The Lindel algorithm requires nucleotide context around the
protospacer sequence; the following full sequence is needed: [13bp
upstream flanking sequence][23bp protospacer sequence] [29bp downstream
flanking sequence], for a total of 65bp. The function
getLindelScores
takes as inputs such 65bp sequences:
The project as a whole is covered by the MIT license. The code for
all underlying Python packages, with their original licenses, can be
found in inst/python
. We made sure that all licenses are
compatible with the MIT license and to indicate changes that we have
made to the original code.
## R version 4.4.2 (2024-10-31)
## Platform: x86_64-pc-linux-gnu
## Running under: Ubuntu 24.04.1 LTS
##
## Matrix products: default
## BLAS: /usr/lib/x86_64-linux-gnu/openblas-pthread/libblas.so.3
## LAPACK: /usr/lib/x86_64-linux-gnu/openblas-pthread/libopenblasp-r0.3.26.so; LAPACK version 3.12.0
##
## locale:
## [1] LC_CTYPE=en_US.UTF-8 LC_NUMERIC=C
## [3] LC_TIME=en_US.UTF-8 LC_COLLATE=C
## [5] LC_MONETARY=en_US.UTF-8 LC_MESSAGES=en_US.UTF-8
## [7] LC_PAPER=en_US.UTF-8 LC_NAME=C
## [9] LC_ADDRESS=C LC_TELEPHONE=C
## [11] LC_MEASUREMENT=en_US.UTF-8 LC_IDENTIFICATION=C
##
## time zone: Etc/UTC
## tzcode source: system (glibc)
##
## attached base packages:
## [1] stats graphics grDevices utils datasets methods base
##
## other attached packages:
## [1] crisprScore_1.11.0 crisprScoreData_1.10.0 ExperimentHub_2.15.0
## [4] AnnotationHub_3.15.0 BiocFileCache_2.15.0 dbplyr_2.5.0
## [7] BiocGenerics_0.53.3 generics_0.1.3 BiocStyle_2.35.0
##
## loaded via a namespace (and not attached):
## [1] KEGGREST_1.47.0 dir.expiry_1.15.0 xfun_0.49
## [4] bslib_0.8.0 lattice_0.22-6 Biobase_2.67.0
## [7] vctrs_0.6.5 tools_4.4.2 parallel_4.4.2
## [10] stats4_4.4.2 curl_6.0.1 tibble_3.2.1
## [13] fansi_1.0.6 AnnotationDbi_1.69.0 RSQLite_2.3.8
## [16] blob_1.2.4 pkgconfig_2.0.3 Matrix_1.7-1
## [19] S4Vectors_0.45.2 lifecycle_1.0.4 GenomeInfoDbData_1.2.13
## [22] stringr_1.5.1 compiler_4.4.2 Biostrings_2.75.1
## [25] GenomeInfoDb_1.43.2 htmltools_0.5.8.1 sys_3.4.3
## [28] buildtools_1.0.0 sass_0.4.9 yaml_2.3.10
## [31] pillar_1.9.0 crayon_1.5.3 jquerylib_0.1.4
## [34] cachem_1.1.0 basilisk_1.19.0 tidyselect_1.2.1
## [37] digest_0.6.37 stringi_1.8.4 dplyr_1.1.4
## [40] BiocVersion_3.21.1 maketools_1.3.1 grid_4.4.2
## [43] fastmap_1.2.0 cli_3.6.3 magrittr_2.0.3
## [46] randomForest_4.7-1.2 utf8_1.2.4 filelock_1.0.3
## [49] UCSC.utils_1.3.0 rappdirs_0.3.3 bit64_4.5.2
## [52] rmarkdown_2.29 XVector_0.47.0 httr_1.4.7
## [55] bit_4.5.0 reticulate_1.40.0 png_0.1-8
## [58] memoise_2.0.1 evaluate_1.0.1 knitr_1.49
## [61] basilisk.utils_1.19.0 IRanges_2.41.1 rlang_1.1.4
## [64] Rcpp_1.0.13-1 glue_1.8.0 DBI_1.2.3
## [67] BiocManager_1.30.25 jsonlite_1.8.9 R6_2.5.1
## [70] zlibbioc_1.52.0