R/cv.R

In lifs-tools/rmzTab-m: R Package Client for mzTab-M Reference Implementation and Validation API

# mzTab-M reference implementation and validation API.
#
# This is the mzTab-M reference implementation and validation API service.
#
# The version of the OpenAPI document: 2.0.0
# Contact: nils.hoffmann@cebitec.uni-bielefeld.de
# Generated by: https://openapi-generator.tech

#' @docType class
#' @title CV
#' @description CV Class
#' @format An \code{R6Class} generator object
#' @field id  integer [optional]
#'
#' @field label  character 
#'
#' @field full_name  character 
#'
#' @field version  character 
#'
#' @field uri  character 
#'
#'
#' @importFrom R6 R6Class
#' @importFrom jsonlite fromJSON toJSON
#' @export
CV <- R6::R6Class(
  'CV',
  public = list(
    `id` = NULL,
    `label` = NULL,
    `full_name` = NULL,
    `version` = NULL,
    `uri` = NULL,
    #' @description Create a CV
    #' @param label CV label.
    #' @param full_name CV full name.
    #' @param version CV version.
    #' @param uri URI to external CV.
    #' @param id URI id.
    #' @param ... local optional variable arguments
    #' 
    initialize = function(`label`, `full_name`, `version`, `uri`, `id`=NULL, ...){
      local.optional.var <- list(...)
      if (!missing(`label`)) {
        stopifnot(is.character(`label`), length(`label`) == 1)
        self$`label` <- `label`
      }
      if (!missing(`full_name`)) {
        stopifnot(is.character(`full_name`), length(`full_name`) == 1)
        self$`full_name` <- `full_name`
      }
      if (!missing(`version`)) {
        stopifnot(is.character(`version`), length(`version`) == 1)
        self$`version` <- `version`
      }
      if (!missing(`uri`)) {
        stopifnot(is.character(`uri`), length(`uri`) == 1)
        self$`uri` <- `uri`
      }
      if (!is.null(`id`)) {
        stopifnot(is.numeric(`id`), length(`id`) == 1)
        self$`id` <- `id`
      }
    },
    #' @description Serialize to list object suitable for jsonlite
    toJSON = function() {
      CVObject <- list()
      if (!is.null(self$`id`)) {
        CVObject[['id']] <-
          rmzTabM::safe_unbox(self$`id`)
      }
      if (!is.null(self$`label`)) {
        CVObject[['label']] <-
          rmzTabM::safe_unbox(self$`label`)
      }
      if (!is.null(self$`full_name`)) {
        CVObject[['full_name']] <-
          rmzTabM::safe_unbox(self$`full_name`)
      }
      if (!is.null(self$`version`)) {
        CVObject[['version']] <-
          rmzTabM::safe_unbox(self$`version`)
      }
      if (!is.null(self$`uri`)) {
        CVObject[['uri']] <-
          rmzTabM::safe_unbox(self$`uri`)
      }

      CVObject
    },
    #' @description Deserialize from jsonlite list object
    #' @param CVJson list object.    
    fromJSON = function(CVJson) {
      CVObject <- jsonlite::fromJSON(CVJson)
      if (!is.null(CVObject$`id`)) {
        self$`id` <- CVObject$`id`
      }
      if (!is.null(CVObject$`label`)) {
        self$`label` <- CVObject$`label`
      }
      if (!is.null(CVObject$`full_name`)) {
        self$`full_name` <- CVObject$`full_name`
      }
      if (!is.null(CVObject$`version`)) {
        self$`version` <- CVObject$`version`
      }
      if (!is.null(CVObject$`uri`)) {
        self$`uri` <- CVObject$`uri`
      }
    },
    #' @description Serialize to JSON string.
    toJSONString = function() {
      jsoncontent <- c(
        if (!is.null(self$`id`)) {
        sprintf(
        '"id":
          %d
                ',
        rmzTabM::safe_unbox(self$`id`)
        )},
        if (!is.null(self$`label`)) {
        sprintf(
        '"label":
          "%s"
                ',
        rmzTabM::safe_unbox(self$`label`)
        )},
        if (!is.null(self$`full_name`)) {
        sprintf(
        '"full_name":
          "%s"
                ',
        rmzTabM::safe_unbox(self$`full_name`)
        )},
        if (!is.null(self$`version`)) {
        sprintf(
        '"version":
          "%s"
                ',
        rmzTabM::safe_unbox(self$`version`)
        )},
        if (!is.null(self$`uri`)) {
        sprintf(
        '"uri":
          "%s"
                ',
        rmzTabM::safe_unbox(self$`uri`)
        )}
      )
      jsoncontent <- paste(jsoncontent, collapse = ",")
      paste('{', jsoncontent, '}', sep = "")
    },
    #' @description Deserialize from JSON string
    #' @param CVJson JSON string
    fromJSONString = function(CVJson) {
      CVObject <- jsonlite::fromJSON(CVJson)
      self$`id` <- CVObject$`id`
      self$`label` <- CVObject$`label`
      self$`full_name` <- CVObject$`full_name`
      self$`version` <- CVObject$`version`
      self$`uri` <- CVObject$`uri`
      self
    },
    #' @description Serialize to data frame    
    toDataFrame = function() {
      idPrefix <- paste0("cv[", self$`id`, "]")
      elements <- data.frame(PREFIX=character(), KEY=character(), VALUE=character())
      if (!is.null(self$`label`)) {
        elements <-
          rbind(elements,
                list(
                  PREFIX = "MTD",
                  KEY = paste(idPrefix, "label", sep = "-"),
                  VALUE = self$`label`
                ),
                stringsAsFactors = FALSE)
      }
      if (!is.null(self$`full_name`)) {
        elements <-
          rbind(elements,
                list(
                  PREFIX = "MTD",
                  KEY = paste(idPrefix, "full_name", sep = "-"),
                  VALUE = self$`full_name`
                ),
                stringsAsFactors = FALSE)
      }
      if (!is.null(self$`version`)) {
        elements <-
          rbind(elements,
                list(
                  PREFIX = "MTD",
                  KEY = paste(idPrefix, "version", sep = "-"),
                  VALUE = self$`version`
                ),
                stringsAsFactors = FALSE)
      }
      if (!is.null(self$`uri`)) {
        elements <-
          rbind(elements,
                list(
                  PREFIX = "MTD",
                  KEY = paste(idPrefix, "uri", sep = "-"),
                  VALUE = self$`uri`
                ),
                stringsAsFactors = FALSE)
      }
      elements
    },
    #' @description Deserialize from CV data frame
    #' @param CvDataFrame CV data frame
    fromDataFrame = function(CvDataFrame) {
      stopifnot(nrow(CvDataFrame)==1)
      if (rlang::has_name(CvDataFrame, "id")) {
        self$`id` <- as.numeric(CvDataFrame$`id`)
      }
      if (rlang::has_name(CvDataFrame, "label")) {
        self$`label` <- CvDataFrame$`label`
      }
      if (rlang::has_name(CvDataFrame, "full_name")) {
        self$`full_name` <- CvDataFrame$`full_name`
      }
      if (rlang::has_name(CvDataFrame, "version")) {
        self$`version` <- CvDataFrame$`version`
      }
      if (rlang::has_name(CvDataFrame, "uri")) {
        self$`uri` <- CvDataFrame$`uri`
      }
      self
    }
  )
)