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

Felix G.M. Ernst

#### 2020-10-15

#### Package

RNAmodR 1.2.3

# 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.0.3 (2020-10-10)
    ## Platform: x86_64-w64-mingw32/x64 (64-bit)
    ## Running under: Windows Server 2012 R2 x64 (build 9600)
    ##
    ## Matrix products: default
    ##
    ## locale:
    ## [1] LC_COLLATE=C
    ## [2] LC_CTYPE=English_United States.1252
    ## [3] LC_MONETARY=English_United States.1252
    ## [4] LC_NUMERIC=C
    ## [5] LC_TIME=English_United States.1252
    ##
    ## attached base packages:
    ## [1] parallel  stats4    stats     graphics  grDevices utils     datasets
    ## [8] methods   base
    ##
    ## other attached packages:
    ##  [1] RNAmodR_1.2.3            Modstrings_1.4.1         RNAmodR.Data_1.2.0
    ##  [4] ExperimentHubData_1.14.1 AnnotationHubData_1.18.1 futile.logger_1.4.3
    ##  [7] ExperimentHub_1.14.2     AnnotationHub_2.20.2     BiocFileCache_1.12.1
    ## [10] dbplyr_1.4.4             GenomicFeatures_1.40.1   AnnotationDbi_1.50.3
    ## [13] Biobase_2.48.0           Rsamtools_2.4.0          Biostrings_2.56.0
    ## [16] XVector_0.28.0           rtracklayer_1.48.0       GenomicRanges_1.40.0
    ## [19] GenomeInfoDb_1.24.2      IRanges_2.22.2           S4Vectors_0.26.1
    ## [22] BiocGenerics_0.34.0      BiocStyle_2.16.1
    ##
    ## loaded via a namespace (and not attached):
    ##   [1] snow_0.4-3                    backports_1.1.10
    ##   [3] Hmisc_4.4-1                   plyr_1.8.6
    ##   [5] lazyeval_0.2.2                splines_4.0.3
    ##   [7] BiocParallel_1.22.0           ggplot2_3.3.2
    ##   [9] digest_0.6.25                 ensembldb_2.12.1
    ##  [11] htmltools_0.5.0               magick_2.4.0
    ##  [13] magrittr_1.5                  checkmate_2.0.0
    ##  [15] memoise_1.1.0                 BSgenome_1.56.0
    ##  [17] cluster_2.1.0                 ROCR_1.0-11
    ##  [19] matrixStats_0.57.0            askpass_1.1
    ##  [21] prettyunits_1.1.1             jpeg_0.1-8.1
    ##  [23] colorspace_1.4-1              blob_1.2.1
    ##  [25] rappdirs_0.3.1                xfun_0.18
    ##  [27] dplyr_1.0.2                   crayon_1.3.4
    ##  [29] RCurl_1.98-1.2                jsonlite_1.7.1
    ##  [31] graph_1.66.0                  VariantAnnotation_1.34.0
    ##  [33] survival_3.2-7                glue_1.4.2
    ##  [35] gtable_0.3.0                  zlibbioc_1.34.0
    ##  [37] DelayedArray_0.14.1           scales_1.1.1
    ##  [39] futile.options_1.0.1          DBI_1.1.0
    ##  [41] Rcpp_1.0.5                    xtable_1.8-4
    ##  [43] progress_1.2.2                htmlTable_2.1.0
    ##  [45] foreign_0.8-80                bit_4.0.4
    ##  [47] OrganismDbi_1.30.0            Formula_1.2-3
    ##  [49] AnnotationForge_1.30.1        htmlwidgets_1.5.2
    ##  [51] httr_1.4.2                    getopt_1.20.3
    ##  [53] RColorBrewer_1.1-2            ellipsis_0.3.1
    ##  [55] farver_2.0.3                  pkgconfig_2.0.3
    ##  [57] XML_3.99-0.5                  Gviz_1.32.0
    ##  [59] nnet_7.3-14                   labeling_0.3
    ##  [61] reshape2_1.4.4                tidyselect_1.1.0
    ##  [63] rlang_0.4.8                   later_1.1.0.1
    ##  [65] munsell_0.5.0                 biocViews_1.56.2
    ##  [67] BiocVersion_3.11.1            tools_4.0.3
    ##  [69] generics_0.0.2                RSQLite_2.2.1
    ##  [71] evaluate_0.14                 stringr_1.4.0
    ##  [73] fastmap_1.0.1                 yaml_2.2.1
    ##  [75] knitr_1.30                    bit64_4.0.5
    ##  [77] purrr_0.3.4                   AnnotationFilter_1.12.0
    ##  [79] RBGL_1.64.0                   mime_0.9
    ##  [81] formatR_1.7                   xml2_1.3.2
    ##  [83] biomaRt_2.44.4                compiler_4.0.3
    ##  [85] rstudioapi_0.11               curl_4.3
    ##  [87] png_0.1-7                     interactiveDisplayBase_1.26.3
    ##  [89] tibble_3.0.4                  stringi_1.5.3
    ##  [91] highr_0.8                     lattice_0.20-41
    ##  [93] ProtGenerics_1.20.0           Matrix_1.2-18
    ##  [95] vctrs_0.3.4                   stringdist_0.9.6.3
    ##  [97] pillar_1.4.6                  BiocCheck_1.24.0
    ##  [99] lifecycle_0.2.0               RUnit_0.4.32
    ## [101] optparse_1.6.6                BiocManager_1.30.10
    ## [103] data.table_1.13.0             bitops_1.0-6
    ## [105] colorRamps_2.3                httpuv_1.5.4
    ## [107] R6_2.4.1                      latticeExtra_0.6-29
    ## [109] bookdown_0.21                 promises_1.1.1
    ## [111] gridExtra_2.3                 codetools_0.2-16
    ## [113] lambda.r_1.2.4                dichromat_2.0-0
    ## [115] assertthat_0.2.1              SummarizedExperiment_1.18.2
    ## [117] openssl_1.4.3                 rBiopaxParser_2.28.0
    ## [119] GenomicAlignments_1.24.0      GenomeInfoDbData_1.2.3
    ## [121] hms_0.5.3                     grid_4.0.3
    ## [123] rpart_4.1-15                  rmarkdown_2.4
    ## [125] biovizBase_1.36.0             shiny_1.5.0
    ## [127] base64enc_0.1-3