R/DataSets.R

#' @name metaboliteInfo
#' @title Test Metabolite Infomation
#' @description Contains metadata on 29 test metabolites with 15 fields
#' @docType data
#' @format a \code{DataFrame} instance, 1 row per metabolite detailing its chemical information
#' @source Fields taken from \code{Metabolon Inc.}
#' @author Michael Epstein
"metaboliteInfo"

#' @name sampleInfo
#' @title Test Sample Infomation
#' @description Contains metadata on 20 samples; 9 from two individuals and 2 pooled samples
#' @docType data
#' @format a \code{DataFrame} instance, 1 row per sample detailing its sample metadata
#' @source Fields taken from \code{Metabolon Inc.}
#' @author Michael Epstein
"sampleInfo"

#' @name metaboliteDataWide
#' @title Test Sample Infomation
#' @description Contains metabolite counts of the 29 test metabolites on the 20 samples
#' @docType data
#' @format a \code{DataFrame} instance, 1 row per sample that gives counts for each of the metabolites
#' @source Randomly sampled Metabolon data
#' @author Michael Epstein
"metaboliteDataWide"
miepstei/MetabolonR documentation built on May 22, 2019, 10:50 p.m.