# RNAmodR: creating classes for additional modification detection from high throughput sequencing.

Felix G.M. Ernst

#### 2021-10-26

#### Package

RNAmodR 1.8.0

# 1 Introduction

For users interested in the general aspect of any `RNAmodR` based package please have a look at the main vignette of the package.

This vignette is aimed at developers and researchers, who want to use the functionality of the `RNAmodR` package to develop a new modification strategy based on high throughput sequencing data.

    library(RNAmodR)

Two classes have to be considered to establish a new analysis pipeline using `RNAmodR`. These are the `SequenceData` and the `Modifier` class.

# 2 A new `SequenceData` class

First, the `SequenceData` class has to be considered. Several classes are already implemented, which are:

- `End5SequenceData`
- `End3SequenceData`
- `EndSequenceData`
- `ProtectedEndSequenceData`
- `CoverageSequenceData`
- `PileupSequenceData`
- `NormEnd5SequenceData`
- `NormEnd3SequenceData`

If these cannot be reused, a new class can be implemented quite easily. First the DataFrame class, the Data class and a constructor has to defined. The only value, which has to be provided, is a default `minQuality` integer value and some basic information.

    setClass(Class = "ExampleSequenceDataFrame",
             contains = "SequenceDFrame")
    ExampleSequenceDataFrame <- function(df, ranges, sequence, replicate,
                                          condition, bamfiles, seqinfo){
      RNAmodR:::.SequenceDataFrame("Example",df, ranges, sequence, replicate,
                                   condition, bamfiles, seqinfo)
    }
    setClass(Class = "ExampleSequenceData",
             contains = "SequenceData",
             slots = c(unlistData = "ExampleSequenceDataFrame"),
             prototype = list(unlistData = ExampleSequenceDataFrame(),
                              unlistType = "ExampleSequenceDataFrame",
                              minQuality = 5L,
                              dataDescription = "Example data"))
    ExampleSequenceData <- function(bamfiles, annotation, sequences, seqinfo, ...){
      RNAmodR:::SequenceData("Example", bamfiles = bamfiles,
                             annotation = annotation, sequences = sequences,
                             seqinfo = seqinfo, ...)
    }

Second, the `getData` function has to be implemented. This is used to load the data from a bam file and must return a named list `IntegerList`, `NumericList` or `CompressedSplitDataFrameList` per file.

    setMethod("getData",
              signature = c(x = "ExampleSequenceData",
                            bamfiles = "BamFileList",
                            grl = "GRangesList",
                            sequences = "XStringSet",
                            param = "ScanBamParam"),
              definition = function(x, bamfiles, grl, sequences, param, args){
                ###
              }
    )

Third, the `aggregate` function has to be implemented. This function is used to aggregate data over replicates for all or one of the conditions. The resulting data is passed on to the `Modifier` class.

    setMethod("aggregateData",
              signature = c(x = "ExampleSequenceData"),
              function(x, condition = c("Both","Treated","Control")){
                ###
              }
    )

# 3 A new `Modifier` class

A new `Modifier` class is probably the main class, which needs to be implemented. Three variable have to be set. `mod` must be a single element from the `Modstrings::shortName(Modstrings::ModRNAString())`. `score` is the default score, which is used for several function. A column with this name should be returned from the `aggregate` function. `dataType` defines the `SequenceData` class to be used. `dataType` can contain multiple names of a `SequenceData` class, which are then combined to form a `SequenceDataSet`.

    setClass("ModExample",
             contains = c("RNAModifier"),
             prototype = list(mod = "X",
                              score = "score",
                              dataType = "ExampleSequenceData"))
    ModExample <- function(x, annotation, sequences, seqinfo, ...){
      RNAmodR:::Modifier("ModExample", x = x, annotation = annotation,
                         sequences = sequences, seqinfo = seqinfo, ...)
    }

`dataType` can also be a `list` of `character` vectors, which leads then to the creation of `SequenceDataList`. However, for now this is a hypothetical case and should only be used, if the detection of a modification requires bam files from two or more different methods to be used to detect one modification.

The `settings<-` function can be amended to save specifc settings ( `.norm_example_args` must be defined seperatly to normalize input arguments in any way one sees fit).

    setReplaceMethod(f = "settings",
                     signature = signature(x = "ModExample"),
                     definition = function(x, value){
                       x <- callNextMethod()
                       # validate special setting here
                       x@settings[names(value)] <- unname(.norm_example_args(value))
                       x
                     })

The `aggregateData` function is used to take the aggregated data from the `SequenceData` object and to calculate the specific scores, which are then stored in the `aggregate` slot.

    setMethod(f = "aggregateData",
              signature = signature(x = "ModExample"),
              definition =
                function(x, force = FALSE){
                  # Some data with element per transcript
                }
    )

The `findMod` function takes the aggregate data and searches for modifications, which are then returned as a GRanges object and stored in the `modifications` slot.

    setMethod("findMod",
              signature = c(x = "ModExample"),
              function(x){
                # an element per modification found.
              }
    )

## 3.1 A new `ModifierSet` class

The `ModifierSet` class is implemented very easily by defining the class and the constructor. The functionality is defined by the `Modifier` class.

    setClass("ModSetExample",
             contains = "ModifierSet",
             prototype = list(elementType = "ModExample"))
    ModSetExample <- function(x, annotation, sequences, seqinfo, ...){
      RNAmodR:::ModifierSet("ModExample", x = x, annotation = annotation,
                            sequences = sequences, seqinfo = seqinfo, ...)
    }

# 4 Visualization functions

Additional functions, which need to be implemented, are `getDataTrack` for the new `SequenceData` and new `Modifier` classes and `plotData`/`plotDataByCoord` for the new `Modifier` and `ModifierSet` classes. `name` defines a transcript name found in `names(ranges(x))` and `type` is the data type typically found as a column in the `aggregate` slot.

    setMethod(
      f = "getDataTrack",
      signature = signature(x = "ExampleSequenceData"),
      definition = function(x, name, ...) {
        ###
      }
    )
    setMethod(
      f = "getDataTrack",
      signature = signature(x = "ModExample"),
      definition = function(x, name, type, ...) {
      }
    )
    setMethod(
      f = "plotDataByCoord",
      signature = signature(x = "ModExample", coord = "GRanges"),
      definition = function(x, coord, type = "score", window.size = 15L, ...) {
      }
    )
    setMethod(
      f = "plotData",
      signature = signature(x = "ModExample"),
      definition = function(x, name, from, to, type = "score", ...) {
      }
    )
    setMethod(
      f = "plotDataByCoord",
      signature = signature(x = "ModSetExample", coord = "GRanges"),
      definition = function(x, coord, type = "score", window.size = 15L, ...) {
      }
    )
    setMethod(
      f = "plotData",
      signature = signature(x = "ModSetExample"),
      definition = function(x, name, from, to, type = "score", ...) {
      }
    )

If unsure, how to modify these functions, have a look a the code in the `Modifier-Inosine-viz.R` file of this package.

# 5 Summary

As suggested directly above, for a more detailed example have a look at the `ModInosine` class source code found in the `Modifier-Inosine-class.R` and `Modifier-Inosine-viz.R` files of this package.

# 6 Sessioninfo

    sessionInfo()

    ## R version 4.1.1 (2021-08-10)
    ## Platform: x86_64-pc-linux-gnu (64-bit)
    ## Running under: Ubuntu 20.04.3 LTS
    ##
    ## Matrix products: default
    ## BLAS:   /home/biocbuild/bbs-3.14-bioc/R/lib/libRblas.so
    ## LAPACK: /home/biocbuild/bbs-3.14-bioc/R/lib/libRlapack.so
    ##
    ## 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
    ##
    ## attached base packages:
    ## [1] stats4    stats     graphics  grDevices utils     datasets  methods
    ## [8] base
    ##
    ## other attached packages:
    ##  [1] RNAmodR_1.8.0            Modstrings_1.10.0        RNAmodR.Data_1.7.0
    ##  [4] ExperimentHubData_1.20.0 AnnotationHubData_1.24.0 futile.logger_1.4.3
    ##  [7] ExperimentHub_2.2.0      AnnotationHub_3.2.0      BiocFileCache_2.2.0
    ## [10] dbplyr_2.1.1             GenomicFeatures_1.46.0   AnnotationDbi_1.56.0
    ## [13] Biobase_2.54.0           Rsamtools_2.10.0         Biostrings_2.62.0
    ## [16] XVector_0.34.0           rtracklayer_1.54.0       GenomicRanges_1.46.0
    ## [19] GenomeInfoDb_1.30.0      IRanges_2.28.0           S4Vectors_0.32.0
    ## [22] BiocGenerics_0.40.0      BiocStyle_2.22.0
    ##
    ## loaded via a namespace (and not attached):
    ##   [1] backports_1.2.1               Hmisc_4.6-0
    ##   [3] plyr_1.8.6                    lazyeval_0.2.2
    ##   [5] splines_4.1.1                 BiocParallel_1.28.0
    ##   [7] ggplot2_3.3.5                 digest_0.6.28
    ##   [9] ensembldb_2.18.0              htmltools_0.5.2
    ##  [11] magick_2.7.3                  fansi_0.5.0
    ##  [13] checkmate_2.0.0               magrittr_2.0.1
    ##  [15] memoise_2.0.0                 BSgenome_1.62.0
    ##  [17] cluster_2.1.2                 ROCR_1.0-11
    ##  [19] matrixStats_0.61.0            prettyunits_1.1.1
    ##  [21] jpeg_0.1-9                    colorspace_2.0-2
    ##  [23] blob_1.2.2                    rappdirs_0.3.3
    ##  [25] xfun_0.27                     dplyr_1.0.7
    ##  [27] crayon_1.4.1                  RCurl_1.98-1.5
    ##  [29] jsonlite_1.7.2                graph_1.72.0
    ##  [31] VariantAnnotation_1.40.0      survival_3.2-13
    ##  [33] glue_1.4.2                    gtable_0.3.0
    ##  [35] zlibbioc_1.40.0               DelayedArray_0.20.0
    ##  [37] scales_1.1.1                  futile.options_1.0.1
    ##  [39] DBI_1.1.1                     Rcpp_1.0.7
    ##  [41] htmlTable_2.3.0               xtable_1.8-4
    ##  [43] progress_1.2.2                foreign_0.8-81
    ##  [45] bit_4.0.4                     OrganismDbi_1.36.0
    ##  [47] Formula_1.2-4                 AnnotationForge_1.36.0
    ##  [49] htmlwidgets_1.5.4             httr_1.4.2
    ##  [51] getopt_1.20.3                 RColorBrewer_1.1-2
    ##  [53] ellipsis_0.3.2                farver_2.1.0
    ##  [55] pkgconfig_2.0.3               XML_3.99-0.8
    ##  [57] nnet_7.3-16                   Gviz_1.38.0
    ##  [59] sass_0.4.0                    utf8_1.2.2
    ##  [61] labeling_0.4.2                reshape2_1.4.4
    ##  [63] tidyselect_1.1.1              rlang_0.4.12
    ##  [65] later_1.3.0                   munsell_0.5.0
    ##  [67] biocViews_1.62.0              BiocVersion_3.14.0
    ##  [69] tools_4.1.1                   cachem_1.0.6
    ##  [71] generics_0.1.1                RSQLite_2.2.8
    ##  [73] evaluate_0.14                 stringr_1.4.0
    ##  [75] fastmap_1.1.0                 yaml_2.2.1
    ##  [77] knitr_1.36                    bit64_4.0.5
    ##  [79] purrr_0.3.4                   AnnotationFilter_1.18.0
    ##  [81] KEGGREST_1.34.0               RBGL_1.70.0
    ##  [83] mime_0.12                     formatR_1.11
    ##  [85] xml2_1.3.2                    biomaRt_2.50.0
    ##  [87] rstudioapi_0.13               compiler_4.1.1
    ##  [89] filelock_1.0.2                curl_4.3.2
    ##  [91] png_0.1-7                     interactiveDisplayBase_1.32.0
    ##  [93] tibble_3.1.5                  bslib_0.3.1
    ##  [95] stringi_1.7.5                 highr_0.9
    ##  [97] lattice_0.20-45               ProtGenerics_1.26.0
    ##  [99] Matrix_1.3-4                  vctrs_0.3.8
    ## [101] stringdist_0.9.8              pillar_1.6.4
    ## [103] BiocCheck_1.30.0              lifecycle_1.0.1
    ## [105] RUnit_0.4.32                  optparse_1.7.1
    ## [107] BiocManager_1.30.16           jquerylib_0.1.4
    ## [109] data.table_1.14.2             bitops_1.0-7
    ## [111] colorRamps_2.3                httpuv_1.6.3
    ## [113] R6_2.5.1                      BiocIO_1.4.0
    ## [115] latticeExtra_0.6-29           bookdown_0.24
    ## [117] promises_1.2.0.1              gridExtra_2.3
    ## [119] codetools_0.2-18              dichromat_2.0-0
    ## [121] lambda.r_1.2.4                assertthat_0.2.1
    ## [123] SummarizedExperiment_1.24.0   rjson_0.2.20
    ## [125] withr_2.4.2                   GenomicAlignments_1.30.0
    ## [127] GenomeInfoDbData_1.2.7        parallel_4.1.1
    ## [129] hms_1.1.1                     rpart_4.1-15
    ## [131] grid_4.1.1                    rmarkdown_2.11
    ## [133] MatrixGenerics_1.6.0          biovizBase_1.42.0
    ## [135] base64enc_0.1-3               shiny_1.7.1
    ## [137] restfulr_0.0.13