R/datasets.R

#' A Small L100 Example PharmacoSet
#'
#' A small example version of the L1000 PharmacoSet, used in the
#' documentation examples. There is also a corresponding drug perturbation signature
#' created from this data for use in the examples (drugPertEx). All credit for the data goes to the
#' Broad Institute. This is not a full version of the dataset, most of
#' of the dataset was removed to make runnable example code. For the full dataset,
#' please download using the downloadPSet function of PharmacoGx.
#'
#' @docType data
#' @name psetSub
#' @usage data(psetSub)
#' @keywords datasets
#' @format PharmacoSet object
#'
NULL

#' rankDrugsGwc output data frame
#'
#' A dataframe returned from the rankDrugsGwc.R function, used in the
#' documentation examples.
#'
#' @docType data
#' @name breastCompRes
#' @usage data(breastCompRes)
#' @keywords datasets
#' @format data frame
#'
NULL

#' CMAP drug clinical trial info
#'
#' A dataframe containing the clinical trial results for many of the CMAP drugs,
#' used for benchmarking various drug repurposing techniques and to provide additional
#' info about the drugs.
#'
#' @docType data
#' @name cmapTrialInfo
#' @usage data(cmapTrialInfo)
#' @keywords datasets
#' @format data frame
#'
NULL

#' Drug perturbation signature example
#'
#' A small example version of the L1000 PharmacoSet, used in the
#' documentation examples. There is also a corresponding Pharmacoset object
#' used to create this signature for use in the examples (psetSub). All credit for the data goes to the
#' Broad Institute. This is not a full version of the dataset, most of
#' of the dataset was removed to make runnable example code. For the full dataset,
#' please download using the downloadPSet function of PharmacoGx.

#'
#' @docType data
#' @name drugPertEx
#' @usage data(drugPertEx)
#' @keywords datasets
#' @format PharmacoSig object
#'
NULL

#' rankDrugsGwc output data frame generated from the example
#'
#' The dataframe returned from the example in the rankDrugsGwc.R function, generated by passing
#' drugPertEx and psetSub into the function
#'
#' @docType data
#' @name drugResults
#' @usage data(drugResults)
#' @keywords datasets
#' @format data frame
#'
NULL

#' Differential expression data frame
#'
#' a list of differentially expressed genes between a disease state and a normal state, the data has the t-saats,
#' corresponding p values, and log(fold-change) for each gene. Used to run examples throughout the package.
#'
#' @docType data
#' @name geneDataGwc
#' @usage data(geneDataGwc)
#' @keywords datasets
#' @format data frame
#'
NULL
bhklab/CMapBox documentation built on Nov. 6, 2019, 8:07 p.m.