R/sumSpectra.R

In ChemoSpecUtils: Functions Supporting Packages ChemoSpec and ChemoSpec2D

#'
#' Summarize a Spectra or Spectra2D Object
#'
#' Provides a summary of a \code{\link[ChemoSpec]{Spectra}}
#' or \code{\link[ChemoSpec2D]{Spectra2D}} object,
#' essentially a more spectroscopist-friendly version of \code{str()}.
#'
#' Prior to summarizing, \code{\link{chkSpectra}} is run with confirm = FALSE.
#' If there are problems, warnings are issued to the console and the summary is
#' not done.
#' The \code{\link[ChemoSpec]{Spectra}} or \code{\link[ChemoSpec2D]{Spectra2D}}
#' object is checked to see if it contains data elements
#' beyond what is required.  If so, these extra elements are reported to the
#' console.
#'
#' @param spectra `r .writeDoc_Spectra3()`
#'
#' @param ...  Arguments to be passed downstream.  Main use is to pass a value for \code{tol}
#'             to function \code{\link{check4Gaps}} when using \code{ChemoSpec}.
#'             Not used in \code{ChemoSpec2D}.
#'
#' @return None.  Results printed at console.
#'
#' @author `r .writeDoc_Authors("BH")`
#'
#' @keywords utilities
#'
#' @export
#'
#' @examples
#' if (checkForPackageWithVersion("ChemoSpec", 6.0)) {
#'   library("ChemoSpec")
#'   data(SrE.IR)
#'   sumSpectra(SrE.IR)
#' }
#'
#' if (checkForPackageWithVersion("ChemoSpec2D", 0.5)) {
#'   library("ChemoSpec2D")
#'   data(MUD1)
#'   sumSpectra(MUD1)
#' }
sumSpectra <- function(spectra, ...) {
  UseMethod("sumSpectra")
}