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, ...)
# Default S3 method
getSoluteProperties(x, return.null = FALSE, ...)
# S3 method for class 'solute_spct'
getSoluteProperties(x, return.null = FALSE, ...)
# S3 method for class 'summary_solute_spct'
getSoluteProperties(x, return.null = FALSE, ...)
# S3 method for class 'solute_mspct'
getSoluteProperties(x, return.null = FALSE, ..., idx = "spct.idx")
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 toNA
.- ...
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.
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
.
Methods (by class)
getSoluteProperties(default)
: defaultgetSoluteProperties(solute_spct)
: solute_spctgetSoluteProperties(summary_solute_spct)
: summary_solute_spctgetSoluteProperties(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()
,
subset_attributes()
,
trimInstrDesc()
,
trimInstrSettings()