R/sample_dataset.R

In ELAplus: Energy Landscape Analysis for Ecological Communities

#' Abundance table for 16 taxa across 256 samples
#'
#' `baseabtable` is a data frame containing abundance for 16 taxa across 256 samples.
#'
#' Each row corresponds to a sample, and each column represents
#' the abundance of a specific taxon.
#'
#' @format A data frame with 256 rows and 16 variables:
#'
#' @details
#' The values represent abundance measurements for each taxon in each sample.
#' The exact definition of "abundance" (e.g., counts, relative abundance, or normalized values)
#' depends on the data preprocessing pipeline used.
#'
#' @source Generated for example purposes (replace with actual source if applicable)
#'
#' @examples
#' data(baseabtable)
#' head(baseabtable)
#' formatted <- Formatting(baseabtable = baseabtable)
"baseabtable"

#' Environmental metadata for 256 samples
#'
#' `basemetadata` is a data frame containing environmental parameters
#' associated with the same 256 samples as in \code{baseabtable}.
#'
#' Each row corresponds to a sample, and each column represents
#' an environmental variable.
#'
#' @format A data frame with 256 rows and 2 variables:
#'
#' @details
#' The rows in this data frame correspond to the same samples and
#' ordering as in \code{baseabtable}. These variables can be used
#' for ELA with environmental parameters such as \code{gradELA}
#'
#' @source Generated for example purposes (replace with actual source if applicable)
#'
#' @examples
#' data(baseabtable)
#' data(basemetadata)
#' head(basemetadata)
#' formatted <- Formatting(baseabtable = baseabtable, basemetadata = basemetadata)
"basemetadata"