R/data.R

In waldronlab/TCGAutils: TCGA utility functions for data management

#' TCGA Cancer Disease Codes Table
#'
#' A dataset for obtaining the cancer codes in TCGA for about 13 different
#' types of cancers.
#'
#' @format A data frame with 37 rows and 2 variables:
#' \describe{
#'      \item{Study.Abbreviation}{Disease Code used in TCGA}
#'      \item{Available}{Cancer datasets available via curatedTCGAData}
#'      \item{SubtypeData}{Subtype curation data available via curatedTCGAData}
#'      \item{Study.Name}{The full length study name (i.e., type of cancer)}
#' }
#' @return The TCGA `diseaseCodes` table
#' @usage data("diseaseCodes")
#' @source \url{https://gdc.cancer.gov/resources-tcga-users/tcga-code-tables/tcga-study-abbreviations}
"diseaseCodes"

#' Barcode Sample Type Table
#'
#' A dataset that contains the mappings for sample codes in the TCGA
#' barcodes.
#' @format A data frame with 19 rows and 3 variables:
#' \describe{
#'      \item{Code}{Two digit code number found in the barcode}
#'      \item{Definition}{Long name for the sample type}
#'      \item{Short.Letter.Code}{Letter code for the sample type}
#' }
#' @return The TCGA `sampleTypes` table
#' @usage data("sampleTypes")
#' @source \url{https://gdc.cancer.gov/resources-tcga-users/tcga-code-tables/sample-type-codes}
"sampleTypes"

#' Clinical dataset names in TCGA
#'
#' A dataset of names for each of the TCGA cancer codes available.
#' These names were obtained by the clinical datasets from
#' \link[RTCGAToolbox]{getFirehoseData}. They serve to subset the current
#' datasets provided by `curatedTCGAData`.
#'
#' @format A \linkS4class{CharacterList} of names for 33 cancer codes
#'
#' @return The clinical dataset column names in TCGA as provided by the
#' `RTCGAToolbox`
#' @usage data("clinicalNames")
"clinicalNames"