R/datasets.R

In schuyler-smith/phyloschuyler: Functions to help analyze data as phyloseq objects

#' Soil Column 16S Data - OTUs
#'
#' This dataset was from an experiment that looked at how microbes from
#' manure used as fertilizer move through soil systems. The manure was
#' applied to the soil in a controlled system, and rain simulations were
#' conducted. The soil was tested at various time points, as was the water
#' that ran through the soil (effluent).
#' @docType data
#' @usage data(soil_column)
#' @format A \code{\link[phyloseq]{phyloseq-class}} object.
#' @keywords datasets
#' @source Experiment
#' @references
#' \url{https://www.frontiersin.org/articles/10.3389/fmicb.2018.03197/full}
"soil_column"

#' Mock Phyloseq Object 1
#'
#' These datasets were made-up for the purpose
#' of demonstrating the examples of the functions.
#' They are not biologically accurate, and don't
#' represent anything meaningful beyond being
#' functional phyloseq objects.
#'
#' @docType data
#' @usage data(mock_phyloseq)
#' @format A \code{\link[phyloseq]{phyloseq-class}} object.
#' @keywords datasets
#' @source Simulation
"mock_phyloseq"

#' Mock Phyloseq Object 2
#'
#' These datasets were made-up for the purpose
#' of demonstrating the examples of the functions.
#' They are not biologically accurate, and don't
#' represent anything meaningful beyond being
#' functional phyloseq objects.
#'
#' @docType data
#' @usage data(mock_phyloseq_2)
#' @format A \code{\link[phyloseq]{phyloseq-class}} object.
#' @keywords datasets
#' @source Simulation
"mock_phyloseq_2"

#' IA Lake Data
#'
#' This data is from microbiomes associate with Lakes in 
#' Iowa, USA between 2018 and 2019.
#'
#' @docType data
#' @usage data(ia_lakes)
#' @format A \code{\link[phyloseq]{phyloseq-class}} object.
#' @keywords datasets
#' @source Simulation
"ia_lakes"