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

Felix G.M. Ernst

#### 2019-10-29

#### Package

RNAmodR 1.0.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 3.6.1 (2019-07-05)
    ## Platform: x86_64-pc-linux-gnu (64-bit)
    ## Running under: Ubuntu 18.04.3 LTS
    ##
    ## Matrix products: default
    ## BLAS:   /home/biocbuild/bbs-3.10-bioc/R/lib/libRblas.so
    ## LAPACK: /home/biocbuild/bbs-3.10-bioc/R/lib/libRlapack.so
    ##
    ## 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
    ##
    ## attached base packages:
    ## [1] parallel  stats4    stats     graphics  grDevices utils     datasets
    ## [8] methods   base
    ##
    ## other attached packages:
    ##  [1] RNAmodR_1.0.0            Modstrings_1.2.0
    ##  [3] RNAmodR.Data_0.99.6      ExperimentHubData_1.12.0
    ##  [5] AnnotationHubData_1.16.0 futile.logger_1.4.3
    ##  [7] ExperimentHub_1.12.0     AnnotationHub_2.18.0
    ##  [9] BiocFileCache_1.10.0     dbplyr_1.4.2
    ## [11] GenomicFeatures_1.38.0   AnnotationDbi_1.48.0
    ## [13] Biobase_2.46.0           Rsamtools_2.2.0
    ## [15] Biostrings_2.54.0        XVector_0.26.0
    ## [17] rtracklayer_1.46.0       GenomicRanges_1.38.0
    ## [19] GenomeInfoDb_1.22.0      IRanges_2.20.0
    ## [21] S4Vectors_0.24.0         BiocGenerics_0.32.0
    ## [23] BiocStyle_2.14.0
    ##
    ## loaded via a namespace (and not attached):
    ##   [1] RUnit_0.4.32                  tidyselect_0.2.5
    ##   [3] RSQLite_2.1.2                 htmlwidgets_1.5.1
    ##   [5] grid_3.6.1                    BiocParallel_1.20.0
    ##   [7] munsell_0.5.0                 codetools_0.2-16
    ##   [9] colorspace_1.4-1              OrganismDbi_1.28.0
    ##  [11] highr_0.8                     knitr_1.25
    ##  [13] rstudioapi_0.10               ROCR_1.0-7
    ##  [15] assertive.base_0.0-7          labeling_0.3
    ##  [17] optparse_1.6.4                GenomeInfoDbData_1.2.2
    ##  [19] bit64_0.9-7                   vctrs_0.2.0
    ##  [21] lambda.r_1.2.4                xfun_0.10
    ##  [23] biovizBase_1.34.0             R6_2.4.0
    ##  [25] assertive.sets_0.0-3          AnnotationFilter_1.10.0
    ##  [27] bitops_1.0-6                  DelayedArray_0.12.0
    ##  [29] assertthat_0.2.1              promises_1.1.0
    ##  [31] scales_1.0.0                  nnet_7.3-12
    ##  [33] gtable_0.3.0                  biocViews_1.54.0
    ##  [35] ensembldb_2.10.0              rlang_0.4.1
    ##  [37] zeallot_0.1.0                 splines_3.6.1
    ##  [39] lazyeval_0.2.2                acepack_1.4.1
    ##  [41] dichromat_2.0-0               checkmate_1.9.4
    ##  [43] BiocManager_1.30.9            yaml_2.2.0
    ##  [45] reshape2_1.4.3                backports_1.1.5
    ##  [47] httpuv_1.5.2                  Hmisc_4.2-0
    ##  [49] RBGL_1.62.0                   tools_3.6.1
    ##  [51] bookdown_0.14                 ggplot2_3.2.1
    ##  [53] gplots_3.0.1.1                assertive.strings_0.0-3
    ##  [55] RColorBrewer_1.1-2            assertive.reflection_0.0-4
    ##  [57] Rcpp_1.0.2                    plyr_1.8.4
    ##  [59] base64enc_0.1-3               progress_1.2.2
    ##  [61] zlibbioc_1.32.0               purrr_0.3.3
    ##  [63] RCurl_1.95-4.12               prettyunits_1.0.2
    ##  [65] rpart_4.1-15                  openssl_1.4.1
    ##  [67] SummarizedExperiment_1.16.0   cluster_2.1.0
    ##  [69] colorRamps_2.3                assertive.models_0.0-2
    ##  [71] magrittr_1.5                  data.table_1.12.6
    ##  [73] assertive.data_0.0-3          futile.options_1.0.1
    ##  [75] ProtGenerics_1.18.0           matrixStats_0.55.0
    ##  [77] hms_0.5.1                     mime_0.7
    ##  [79] evaluate_0.14                 xtable_1.8-4
    ##  [81] XML_3.98-1.20                 gridExtra_2.3
    ##  [83] compiler_3.6.1                biomaRt_2.42.0
    ##  [85] tibble_2.1.3                  assertive.datetimes_0.0-2
    ##  [87] KernSmooth_2.23-16            crayon_1.3.4
    ##  [89] htmltools_0.4.0               later_1.0.0
    ##  [91] assertive_0.3-5               Formula_1.2-3
    ##  [93] DBI_1.0.0                     formatR_1.7
    ##  [95] assertive.files_0.0-2         rappdirs_0.3.1
    ##  [97] assertive.numbers_0.0-2       Matrix_1.2-17
    ##  [99] getopt_1.20.3                 assertive.types_0.0-3
    ## [101] assertive.matrices_0.0-2      assertive.data.uk_0.0-2
    ## [103] gdata_2.18.0                  Gviz_1.30.0
    ## [105] pkgconfig_2.0.3               GenomicAlignments_1.22.0
    ## [107] foreign_0.8-72                assertive.data.us_0.0-2
    ## [109] stringdist_0.9.5.5            AnnotationForge_1.28.0
    ## [111] BiocCheck_1.22.0              stringr_1.4.0
    ## [113] VariantAnnotation_1.32.0      digest_0.6.22
    ## [115] graph_1.64.0                  assertive.code_0.0-3
    ## [117] rmarkdown_1.16                htmlTable_1.13.2
    ## [119] curl_4.2                      shiny_1.4.0
    ## [121] gtools_3.8.1                  jsonlite_1.6
    ## [123] askpass_1.1                   BSgenome_1.54.0
    ## [125] pillar_1.4.2                  lattice_0.20-38
    ## [127] fastmap_1.0.1                 httr_1.4.1
    ## [129] survival_2.44-1.1             interactiveDisplayBase_1.24.0
    ## [131] glue_1.3.1                    BiocVersion_3.10.1
    ## [133] bit_1.1-14                    assertive.properties_0.0-4
    ## [135] stringi_1.4.3                 blob_1.2.0
    ## [137] latticeExtra_0.6-28           caTools_1.17.1.2
    ## [139] memoise_1.1.0                 rBiopaxParser_2.26.0
    ## [141] dplyr_0.8.3