ChemoSpec (version 3.0-1)

chkSpectra: Verify the Integrity of a Spectra Object

Description

Utility function to verify that the structure of a "Spectra" object (an instance of an S3 object) is internally consistent. Rather than directly manipulating a "Spectra" object, one should manipulate it via removeFreq or removeSample. Should not see much direct use by users.

Usage

chkSpectra(spectra, confirm = FALSE)

Arguments

spectra

An object of S3 class "Spectra" to be checked.

confirm

Logical indicating whether or not to write the results to the console, as would be desirable for interactive use.

Value

• None; messages will be printed at the console if there is a problem.

Details

This function is similar in spirit to validObject in the S4 world. When used at the console, and the object is OK, no message is written unless confirm = TRUE. At the console, if there is a problem, messages are issued regardless of the value of confirm. When used in a function, this function is silent (assuming confirm = FALSE) unless there is a problem.

References

https://github.com/bryanhanson/ChemoSpec

Examples

data(CuticleIR)
chkSpectra(CuticleIR, confirm = TRUE) # OK
# What's next works, but is the wrong way to manipulate a "Spectra" object.
# Use removeSample instead.
remove <- c(20:40) 
CuticleIR$freq <- CuticleIR$freq[-remove]
chkSpectra(CuticleIR, confirm = TRUE) # not OK, you didn't listen to me!