R/data_annotation.R

In variancePartition: Quantify and interpret divers 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
#'
#' info about study design
#'
#' \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
#'
#' Normalized expression data
#'
#' \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"

#' Simulation dataset for dream example
#'
#' Gene counts from RNA-seq
#'
#' \itemize{    
#'	\item countMatrix gene expression in the form of RNA-seq counts
#'  \item metadata metadata about the study design
#' }
#' @docType data
#' @keywords datasets
#' @usage data(varPartDEdata)
#' @format A dataset of 24 samples and 19,364 genes
#' @name varPartDEdata
"countMatrix"

#' Simulation dataset for dream example
#'
#' metadata matrix of sample information
#'
#' \itemize{    
#'	\item countMatrix gene expression in the form of RNA-seq counts
#'  \item metadata metadata about the study design
#' }
#' @docType data
#' @keywords datasets
#' @usage data(varPartDEdata)
#' @format A dataset of 24 samples and 19,364 genes
#' @name varPartDEdata
"metadata"