R/data_docs.R

In zellerlab/SIMBA: Simulation of Microbiome Data with Biological Accuracy

#' @title SIMBA example features
#'
#' @description Taxonomic profiles from the study by Zeevi et al. Cell 2014
#' (see \doi{10.1016/j.cell.2015.11.001}), 
#' containing 1952 features from 1181 samples, created by the motus profiler.
#'
#' Mainly used for running the examples in the function documentation and
#' in the vignette.
#'
#' @encoding UTF-8
#'
#' @name toy.feat
#'
#' @source \doi{10.1016/j.cell.2015.11.001}
#'
#' @docType data
#'
#' @keywords data
NULL

#' @title SIMBA example metadata
#'
#' @description Metadata from the study by Zeevi et al. Cell 2014
#' (see \doi{10.1016/j.cell.2015.11.001}).
#'
#' Mainly used for running the examples in the function documentation and
#' in the vignette.
#'
#' @encoding UTF-8
#'
#' @name toy.meta
#'
#' @source \doi{10.1016/j.cell.2015.11.001}
#'
#' @docType data
#'
#' @keywords data
NULL