R/AllClasses.R

In da-bar/JASPAR2022: Data package for JASPAR database (version 2022)

#' JASPAR2022 object class
#'
#' @description The JASPAR2022 object class is a thin class for storing the path of
#' JASPAR2022 style SQLite file.
#' @aliases JASPAR2022
#' @slot db Object of class \code{"character"} a character string of the path
#'  of SQLite file.
#' @author Damir Baranasic
#' @keywords classes
#' @examples
#' library(TFBSTools)
#' opts <- list()
#' opts[["species"]] <- 9606
#' opts[["type"]] <- "SELEX"
#' opts[["all_versions"]] <- TRUE
#' PFMatrixList <- getMatrixSet(JASPAR2022, opts)
#'
#' opts2 <- list()
#' opts2[["type"]] <- "SELEX"
#' PFMatrixList2 <- getMatrixSet(JASPAR2022, opts2)
#'
#' @import methods
#' @exportClass JASPAR2022
setClass("JASPAR2022", slots = c(db = "character")
         )