R/data.R

In ShixiangWang/iProfile: integrated cancer Profile using multiple datasets

## document datasets, we need to specify @docType and @name
## do not forget NULL in the end

#' bioconductor annotation platform information
#'
#' stored information of annotation platform. You can modify the object directly or
#' modify the platformMap.txt file in \code{system.file("extdata", package="iProfile")}
#' and then use \code{update_refData()} updating the data for permanently use.
#' @docType data
#' @name platformMap
#' @format data.frame
#' @source Generated from \code{update_refData()}
#' @examples data(platformMap)
#' str(platformMap)
NULL

#' a data.frame of HUGO gene symbols
#'
#' stored information of HUGO genes, used for matching genes. You can modify the object directly or
#' modify the HUGO_* file in \code{system.file("extdata", package="iProfile")}
#' and then use \code{update_refData("HUGO")} updating the data for permanently use.
#' @docType data
#' @name hugo
#' @format data.frame
#' @source Generated from \code{update_refData("HUGO")}
#' @examples data(hugo)
#' str(hugo)
NULL