R/datasets_documentation.R

In leffj/mctoolsr: Microbial Community Data Analysis Tools

## datasets documentation

#' Fruits and Vegetables Bacterial Community Data
#' 
#' Taxa table, metadata map, and bacterial taxonomy. Produced using \code{
#' mctoolsr::load_taxa_table()}
#' 
#' @format A list with 3 elements.
#' @source Adapted from \url{
#'  http://journals.plos.org/plosone/article?id=10.1371/journal.pone.0059310}
"fruits_veggies"

#' Taxa Summary from Produce Dataset
#' 
#' Taxa (phyla) relative abundances across all samples in the example dataset.
#' Produced using \code{mctoolsr::summarize_taxonomy()}.
#' 
#' @format A data frame
#' @source Adapted from \url{
#'  http://journals.plos.org/plosone/article?id=10.1371/journal.pone.0059310}
"sumtax_example_data"

#' Fruits and Vegetables Bacterial Phylotype Tree
#' 
#' Phylogenetic tree created using pynast and Fasttree
#' 
#' @format phylo
#' @source Adapted from \url{
#'  http://journals.plos.org/plosone/article?id=10.1371/journal.pone.0059310}
#'  
"fruits_veggies_OTUs_tree"