R/ClassObjectResults.R

In roblanf/sangeranalyseR: sangeranalyseR: a suite of functions for the analysis of Sanger sequence data in R

#' @title ObjectResults
#'
#' @description  An S4 class storing results related inputs in a SangerRead, SangerContig, and SangerAlignment S4 object.
#' 
#' @slot creationResult
#' @slot errorMessages
#' @slot errorTypes
#' @slot warningMessages
#' @slot warningTypes
#' @slot readResultTable
#' @slot printLevel
#'
#' @name ObjectResults-class
#'
#' @exportClass ObjectResults
#' @author Kuan-Hao Chao
#' @examples
#' objectResults <- new("ObjectResults",
#'                      creationResult   = TRUE,
#'                      errorMessages    = character(0),
#'                      errorTypes       = character(0),
#'                      warningMessages  = character(0),
#'                      warningTypes     = character(0),
#'                      readResultTable =  data.frame(),
#'                      printLevel       = "SangerRead")
setClass("ObjectResults",
         ### -------------------------------------------------------------------
         ### Input type of each variable
         ### -------------------------------------------------------------------
         representation(
           creationResult     = "logical",
           errorMessages      = "character",
           errorTypes         = "character",
           warningMessages    = "character",
           warningTypes       = "character",
           readResultTable    = "data.frame",
           printLevel         = "character"
         ),
)

### ============================================================================
### Overwrite initialize for QualityReport (New constructor)
### ============================================================================
setMethod("initialize",
          "ObjectResults",
          function(.Object, ...,
                   creationResult   = TRUE,
                   errorMessages    = character(0),
                   errorTypes       = character(0),
                   warningMessages  = character(0),
                   warningTypes     = character(0),
                   readResultTable  = data.frame(),
                   printLevel       = "SangerRead") {
            callNextMethod(.Object, ...,
                           creationResult   = creationResult,
                           errorMessages    = errorMessages,
                           errorTypes       = errorTypes,
                           warningMessages  = warningMessages,
                           warningTypes     = warningTypes,
                           readResultTable  = readResultTable,
                           printLevel       = printLevel)
          })