R/class_DeepBlueCommand.R

In MPIIComputationalEpigenetics/DeepBlueR: DeepBlueR

#'@title DeepBlueCommand class
#'@export
#'@import methods
#'@importFrom utils write.table download.file
#'@description An S4 class returned when calling
#'a DeepBlue-R function. It holds information about
#'the original call, the query / request status,
#'previous commands, the user_key, and results in GRanges format once
#'a request is downloaded.
#'@param call language
#'@param status character
#'@param query_id character
#'@param previous_commands list
#'@param user_key character
#'@param result GRanges
#'@return class for managin DeepBlue commands
DeepBlueCommand <- setClass("DeepBlueCommand",
                            slots = c(call = "language",
                                      status = "character",
                                      query_id = "character",
                                      previous_commands = "list",
                                      user_key = "character"),
                            validity=function(object) {
                                if (object@status == "error")
                                    return(FALSE)
                                else return(TRUE)
                            },
                            prototype = list(
                                user_key = "anonymous_key",
                                previous_commands = list()
                            )
)