R/proximateCannabis.R

In proximetricsR: Spectral Preprocessing and Chemometric Calibration of NIR Sensors

#' @docType data
#' @name proximateCannabis
#' @aliases proximateCannabis
#' @title proximateCannabis
#' @format A `data.frame` containing 80 observations of four response variables,
#' with their corresponding spectral data.
#' @usage
#' data("proximateCannabis")
#' @description
#' Selected samples of cannabis NIR measurements for demo purposes.
#' The dataset contains absorbance spectra of 80 cannabis samples measured between
#' 1001 nm and 1700 nm at a 3 nm interval. A total number of four reference vectors
#' is included: \code{"CBDA"} (Cannabidiolic acid), \code{"THCA"}
#' (Tetrahydrocannabinolic acid), \code{"CBD"} (Cannabidiol) and \code{"THC"}
#' (Tetrahydrocannabinol).
#' @details
#' This dataset is an example for a typical data file for ProxiMate applications,
#' with a total of 80 cannabis samples, selected as a subset of a larger database.
#'
#' Note that this dataset is unrelated to \code{\link{proxiscoutCannabis}}, which
#' contains a different set of cannabis samples, measured with ProxiScout devices
#' over a different spectral range and accompanied by a different set of reference
#' variables. The two datasets share neither samples nor reference values and
#' cannot be combined.
#'
#' It contains the following rows for each observation:
#' \itemize{
#'     \item \strong{\code{ROW}:} Integers for the associated numbers inside the
#'     database.
#'     \item \strong{\code{Check}:} Characters, indicating whether the particular
#'     observation should be included in the construction of the model inside a
#'     ProxiMate.
#'     \item \strong{\code{Date}:} Characters for the date and time when the
#'     measurement was taken.
#'     \item \strong{\code{SNR}:} Characters of the serial number of the involved
#'     ProxiMate device.
#'     \item \strong{\code{ID:}} Characters for the ID's.
#'     \item \strong{\code{Barcode}:} Characters for the barcodes.
#'     \item \strong{\code{Notes}:} Characters for the notes.
#'     \item \strong{\code{Result}:} Characters for the results.
#'     \item \strong{\code{Reference}:} Characters containing all reference values,
#'     concatented into one character with semicolon separation.
#'     \item \strong{\code{CBDA}:} Numerics for the reference values of Cannabidiolic
#'     acid.
#'     \item \strong{\code{THCA}:} Numerics for the references values of
#'     Tetrahydrocannabinolic acid.
#'     \item \strong{\code{CBD}:} Numerics for the reference values of Cannabidiol.
#'     \item \strong{\code{THC}:} Numerics for the reference values of Tetrahydrocannabinol.
#'     \item \strong{\code{Begin}:} Characters, indicating when the measuring was
#'     initiated.
#'     \item \strong{\code{End}:} Characters, indicating when the measurement was
#'     completed.
#'     \item \strong{\code{Recipe}:} Characters for the recipe.
#'     \item \strong{\code{Composition}:} Characters for the composition of the sample.
#'     \item \strong{\code{Images}:} Characters for the image of the samples.
#'     \item \strong{\code{spc}:} A numerical matrix of the absorbance spectra,
#'     corresponding to each individual observation.
#' }
#' @seealso \code{\link{proxiscoutCannabis}}
#' @source BUCHI Labortechnik AG.
#' @keywords datasets
NULL