photobiology (version 0.10.17)

getSoluteProperties: Get the "solute.properties" attribute

Description

Function to read the "solute.properties" attribute of an existing solute_spct or a solute_mspct objects.

Usage

getSoluteProperties(x, return.null, ...)
solute_properties(x, return.null, ...)
# S3 method for default
getSoluteProperties(x, return.null = FALSE, ...)
# S3 method for solute_spct
getSoluteProperties(x, return.null = FALSE, ...)
# S3 method for summary_solute_spct
getSoluteProperties(x, return.null = FALSE, ...)
# S3 method for solute_mspct
getSoluteProperties(x, return.null = FALSE, ..., idx = "spct.idx")

Value

a list with fields named "mass", "formula",

"structure", "name" and "ID". If the attribute is not set, and return.null is FALSE, a list with fields set to

NA is returned, otherwise, NULL.

Arguments

x

solute_spct A spectrum of coefficients of attenuation.

return.null

logical If true, NULL is returned if the attribute is not set, otherwise the expected list is returned with all fields set to NA.

...

Allows use of additional arguments in methods for other classes.

idx

character Name of the column with the names of the members of the collection of spectra.

Methods (by class)

• getSoluteProperties(default): default

• getSoluteProperties(solute_spct): solute_spct

• getSoluteProperties(summary_solute_spct): summary_solute_spct

• getSoluteProperties(solute_mspct): solute_mspct

See Also

Other measurement metadata functions: add_attr2tb(), getFilterProperties(), getHowMeasured(), getInstrDesc(), getInstrSettings(), getWhatMeasured(), getWhenMeasured(), getWhereMeasured(), get_attributes(), isValidInstrDesc(), isValidInstrSettings(), select_spct_attributes(), setFilterProperties(), setHowMeasured(), setInstrDesc(), setInstrSettings(), setSoluteProperties(), setWhatMeasured(), setWhenMeasured(), setWhereMeasured(), spct_attr2tb(), spct_metadata(), trimInstrDesc(), trimInstrSettings()

Examples

solute_properties(water.spct)