R/artificial_dataset.R

In OceanTracer: Marine Source Unmixing Toolkit

#' Artificial Dataset for OceanTracer Workflows
#'
#' Example dataset included with OceanTracer containing isotopic tracer ratios 
#' and concentration data for sediment sources and mixture samples.
#'
#' The dataset contains isotopic amino acid tracer ratios and concentration measurements 
#' for three potential sediment sources (S1, S2, S3) and one mixture sample (Mx). 
#' It is designed for demonstrating source apportionment, conservativeness index (CI) 
#' calculations, and tracer selection workflows.
#'
#' @docType data
#'
#' @format A data frame with 13 rows and 26 columns:
#' \describe{
#'   \item{ID}{Character. Unique sample identifier.}
#'   \item{Sources}{Factor or Character. Source classification group (\code{"S1"}, \code{"S2"}, \code{"S3"}) or mixture sample (\code{"Mx"}).}
#'   \item{R_Ala, R_Asp, R_Glu, R_Ile, R_Leu, R_Pro, R_Val, R_Gly, R_Lys, R_Phe, R_Ser, R_Thr}{Numeric. Isotopic ratios for individual amino acids.}
#'   \item{Conc_Ala, Conc_Asp, Conc_Glu, Conc_Ile, Conc_Leu, Conc_Pro, Conc_Val, Conc_Gly, Conc_Lys, Conc_Phe, Conc_Ser, Conc_Thr}{Numeric. Amino acid concentrations.}
#' }
#' @return A data frame containing the artificial data values.
#' @source Synthetic example dataset created for the OceanTracer package.
#'
#' @keywords datasets
#'
#' @examples
#' data("artificial_dataset")
#' head(artificial_dataset)
"artificial_dataset"