This vignettes introduces the KdModel and KdModelList classes used for storing miRNA 12-mer affinities and predicting the dissociation constant of specific sites.
scanMiR 1.8.2
McGeary, Lin et al. (2019) used
RNA bind-n-seq (RBNS) to empirically determine the affinities (i.e. dissoiation
rates) of selected miRNAs towards random 12-nucleotide sequences (termed
12-mers). As expected, bound sequences typically exhibited complementarity to
the miRNA seed region (positions 2-8 from the miRNA’s 5’ end), but the study
also revealed non-canonical bindings and the importance of flanking
di-nucleotides. Based on these data, the authors developed a model which
predicted 12-mer dissociation rates (KD) based on the miRNA sequence. ScanMiR
encodes a compressed version of these prediction in the form of a KdModel
object.
The 12-mer is defined as the 8 nucleotides opposite the miRNA’s extended seed region plus flanking dinucleotides on either side:
The KdModel
class contains the information concerning the sequence (12-mer)
affinity of a given miRNA, and is meant to compress and make easily manipulable
the dissociation constants (Kd) predictions from
McGeary, Lin et al. (2019).
We can take a look at the example KdModel
:
library(scanMiR)
data(SampleKdModel)
SampleKdModel
## A `KdModel` for hsa-miR-155-5p (Conserved across mammals)
## Sequence: UUAAUGCUAAUCGUGAUAGGGGUU
## Canonical target seed: AGCATTA(A)
In addition to the information necessary to predict the binding affinity to any
given 12-mer sequence, the model contains, minimally, the name and sequence of
the miRNA. Since the KdModel
class extends the list class, any further
information can be stored:
SampleKdModel$myVariable <- "test"
An overview of the binding affinities can be obtained with the following plot:
plotKdModel(SampleKdModel, what="seeds")
The plot gives the -log(Kd) values of the top 7-mers (including both canonical and non-canonical sites), with or without the final “A” vis-à-vis the first miRNA nucleotide.
To predict the dissociation constant (and binding type, if any) of a given
12-mer sequence, you can use the assignKdType
function:
assignKdType("ACGTACGTACGT", SampleKdModel)
## type log_kd
## 1 non-canonical 0
# or using multiple sequences:
assignKdType(c("CTAGCATTAAGT","ACGTACGTACGT"), SampleKdModel)
## type log_kd
## 1 8mer -5129
## 2 non-canonical 0
The log_kd column contains log(Kd) values multiplied by 1000 and stored as an integer (which is more economical when dealing with millions of sites). In the example above, -5129 means -5.129, or a dissociation constant of 0.0059225. The smaller the values, the stronger the relative affinity.
A KdModelList
object is simply a collection of KdModel
objects. We can
build one in the following way:
# we create a copy of the KdModel, and give it a different name:
mod2 <- SampleKdModel
mod2$name <- "dummy-miRNA"
kml <- KdModelList(SampleKdModel, mod2)
kml
## An object of class "KdModelList"
## [[1]]
## A `KdModel` for hsa-miR-155-5p (Conserved across mammals)
## Sequence: UUAAUGCUAAUCGUGAUAGGGGUU
## Canonical target seed: AGCATTA(A)
## [[2]]
## A `KdModel` for dummy-miRNA (Conserved across mammals)
## Sequence: UUAAUGCUAAUCGUGAUAGGGGUU
## Canonical target seed: AGCATTA(A)
summary(kml)
## A `KdModelList` object containing binding affinity models from 2 miRNAs.
##
## Low-confidence Poorly conserved
## 0 0
## Conserved across mammals Conserved across vertebrates
## 2 0
Beyond operations typically performed on a list (e.g. subsetting), some specific slots of the respective KdModels can be accessed, for example:
conservation(kml)
## hsa-miR-155-5p dummy-miRNA
## Conserved across mammals Conserved across mammals
## 4 Levels: Low-confidence Poorly conserved ... Conserved across vertebrates
KdModel
objects are meant to be created from a table assigning a log_kd
values to 12-mer target sequences, as produced by the CNN from McGeary, Lin et
al. (2019). For the purpose of example, we create such a dummy table:
kd <- dummyKdData()
head(kd)
## X12mer log_kd
## 1 AAAGCAAAAAAA -0.428
## 2 CAAGCACAAACA -0.404
## 3 GAAGCAGAAAGA -0.153
## 4 TAAGCATAAATA -1.375
## 5 ACAGCAACAAAC -0.448
## 6 CCAGCACCAACC -0.274
A KdModel
object can then be created with:
mod3 <- getKdModel(kd=kd, mirseq="TTAATGCTAATCGTGATAGGGGTT", name = "my-miRNA")
Alternatively, the kd
argument can also be the path to the output file of the
CNN (and if mirseq
and name
are in the table, they can be omitted).
The scanMiRData package contains
KdModel
collections corresponding to all human, mouse and rat mirbase miRNAs.
When calling getKdModel
, the dissociation constants are stored as an
lightweight overfitted linear model, with base KDs coefficients (stored as
integers in object$mer8
) for each 1024 partially-matching 8-mers (i.e. at
least 4 consecutive matching nucleotides) to which are added 8-mer-specific
coefficients (stored in object$fl
) that are multiplied with a flanking score
generated by the flanking di-nucleotides. The flanking score is calculated
based on the di-nucleotide effects experimentally measured by McGeary, Lin et
al. (2019). To save space, the actual 8-mer sequences are not stored but
generated when needed in a deterministic fashion. The 8-mers can be obtained,
in the right order, with the getSeed8mers
function.
## R version 4.3.2 Patched (2023-11-13 r85521)
## Platform: x86_64-pc-linux-gnu (64-bit)
## Running under: Ubuntu 22.04.3 LTS
##
## Matrix products: default
## BLAS: /home/biocbuild/bbs-3.18-bioc/R/lib/libRblas.so
## LAPACK: /usr/lib/x86_64-linux-gnu/lapack/liblapack.so.3.10.0
##
## locale:
## [1] LC_CTYPE=en_US.UTF-8 LC_NUMERIC=C
## [3] LC_TIME=en_GB 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: America/New_York
## tzcode source: system (glibc)
##
## attached base packages:
## [1] stats graphics grDevices utils datasets methods base
##
## other attached packages:
## [1] scanMiR_1.8.2 BiocStyle_2.30.0
##
## loaded via a namespace (and not attached):
## [1] sass_0.4.8 utf8_1.2.4 generics_0.1.3
## [4] bitops_1.0-7 stringi_1.8.3 digest_0.6.34
## [7] magrittr_2.0.3 evaluate_0.23 grid_4.3.2
## [10] bookdown_0.37 fastmap_1.1.1 jsonlite_1.8.8
## [13] GenomeInfoDb_1.38.6 BiocManager_1.30.22 fansi_1.0.6
## [16] scales_1.3.0 Biostrings_2.70.2 codetools_0.2-19
## [19] jquerylib_0.1.4 cli_3.6.2 rlang_1.1.3
## [22] crayon_1.5.2 XVector_0.42.0 cowplot_1.1.3
## [25] munsell_0.5.0 withr_3.0.0 cachem_1.0.8
## [28] yaml_2.3.8 tools_4.3.2 parallel_4.3.2
## [31] BiocParallel_1.36.0 seqLogo_1.68.0 dplyr_1.1.4
## [34] colorspace_2.1-0 ggplot2_3.4.4 GenomeInfoDbData_1.2.11
## [37] BiocGenerics_0.48.1 vctrs_0.6.5 R6_2.5.1
## [40] magick_2.8.2 stats4_4.3.2 lifecycle_1.0.4
## [43] zlibbioc_1.48.0 S4Vectors_0.40.2 IRanges_2.36.0
## [46] pkgconfig_2.0.3 bslib_0.6.1 pillar_1.9.0
## [49] gtable_0.3.4 Rcpp_1.0.12 glue_1.7.0
## [52] data.table_1.15.0 xfun_0.42 tibble_3.2.1
## [55] GenomicRanges_1.54.1 tidyselect_1.2.0 highr_0.10
## [58] knitr_1.45 farver_2.1.1 htmltools_0.5.7
## [61] labeling_0.4.3 rmarkdown_2.25 compiler_4.3.2
## [64] RCurl_1.98-1.14