ChemoSpec (version 4.2.8)

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.

Usage

chkSpectra(spectra, confirm = FALSE)

Value

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

Rdversion

1.1

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(metMUD1)
chkSpectra(metMUD1, confirm = TRUE) # OK
# What's next is the wrong way to manipulate a Spectra object.
# Use removeSample instead.
# We won't run during checking as an error is raised
remove <- c(20:40) 
metMUD1$freq <- metMUD1$freq[-remove]
chkSpectra(metMUD1, confirm = TRUE) # not OK, you didn't listen to me!