R: Summarize a Spectra Object

sumSpectra {ChemoSpec} | R Documentation

## Summarize a Spectra Object

### Description

Provides a summary of a `Spectra` object, essentially a more spectroscopist-friendly version of `str()`.

### Usage

    sumSpectra(spectra, ...)

### Arguments

`spectra` | An object of S3 class `Spectra`.
`...` | Arguments to be passed downstream.

### Details

Prior to summarizing, `chkSpectra` is run with confirm = FALSE. If there are problems, warnings are issued to the console and the summary is not done. If `sumSpectra` thinks there is a gap between every data point, add the argument `tol = xx` which will pass through to `check4Gaps` and alleviate this problem (which has to do with rounding when subtracting two adjacent frequency values). The `Spectra` object is checked to see if it contains data elements beyond what is required. If so, these extra elements are reported to the console.

### Value

None. Results printed at console, perhaps a plot as well.

### Author(s)

Bryan A. Hanson, DePauw University.

### References

https://github.com/bryanhanson/ChemoSpec

### Examples

    data(metMUD1)
    sumSpectra(metMUD1)

[Package ChemoSpec version 4.4.97 Index]