R/data_docs.R

In KonradZych/SIAMCAT: Statistical Inference of Associations between Microbial Communities And host phenoTypes

#' Documentation for the example siamcat object in the data folder
#'
#' Reduced version of the CRC dataset in inst/extdata, containing 100 features
#' (15 associated features at 5\% FDR in the original dataset and 85 random
#' other features) and 141 samples, saved after the complete SIAMCAT 
#' pipelinehas been run.
#' Therefore, contains entries in every siamcat-object slot,
#' e.g, \code{eval_data} or \code{data_split}. Mainly used for running
#' the examples in the function documentation
#'     
#' @name siamcat_example
#' 
#' @docType data
#' 
#' @keywords data
NULL