R/data_annotation.R

In GabrielHoffman/variancePartition: Quantify and interpret drivers of variation in multilevel gene expression experiments

#' Simulation dataset for examples
#'
#' A simulated dataset of gene expression and metadata
#'
#' \itemize{
#' 	\item geneCounts gene expression in the form of RNA-seq counts
#' 	\item geneExpr gene expression on a continuous scale
#'  \item info metadata about the study design
#' }
#' @docType data
#' @keywords datasets
#' @usage data(varPartData)
#' @format A dataset of 100 samples and 200 genes
#' @name varPartData
NULL


##' Simulation dataset for examples
##'
##' A simulated dataset of gene counts
##'
##' \itemize{
##' 	\item geneCounts gene expression in the form of RNA-seq counts
##' 	\item geneExpr gene expression on a continuous scale
##'  \item info metadata about the study design
##' }
#' @docType data
#' @keywords datasets
##' @usage data(varPartData)
#' @format A dataset of 100 samples and 200 genes
#' @name varPartData
"geneCounts"

##' Simulation dataset for examples
##'
##' A simulated dataset of gene counts
##'
##' \itemize{
##' 	\item geneCounts gene expression in the form of RNA-seq counts
##' 	\item geneExpr gene expression on a continuous scale
##'  \item info metadata about the study design
##' }
#' @docType data
#' @keywords datasets
#' @usage data(varPartData)
#' @format A dataset of 100 samples and 200 genes
#' @name varPartData
"info"



##' Simulation dataset for examples
##'
##' A simulated dataset of gene counts
##'
##' \itemize{
##' 	\item geneCounts gene expression in the form of RNA-seq counts
##' 	\item geneExpr gene expression on a continuous scale
##'  \item info metadata about the study design
##' }
#' @docType data
#' @keywords datasets
##' @usage data(varPartData)
#' @format A dataset of 100 samples and 200 genes
#' @name varPartData
"geneExpr"

##'
##' A simulated dataset of gene counts
##'
##' \itemize{
##' 	\item geneCounts gene expression in the form of RNA-seq counts
##' 	\item geneExpr gene expression on a continuous scale
##'  \item info metadata about the study design
##' }
#' @docType data
#' @keywords datasets
##' @usage data(varPartData)
#' @format A dataset of 24 samples and 19,364 genes
#' @name varPartDEdata
"countMatrix"

##'
##' A simulated dataset of gene counts
##'
##' \itemize{
##' 	\item geneCounts gene expression in the form of RNA-seq counts
##' 	\item geneExpr gene expression on a continuous scale
##'  \item info metadata about the study design
##' }
#' @docType data
#' @keywords datasets
##' @usage data(varPartData)
#' @format A dataset of 24 samples and 19,364 genes
#' @name varPartDEdata
"metadata"