Skip to contents

Set the "instr.desc" attribute

Source: R/spct.metadata.r
setInstrDesc.Rd

Function to set by reference the "instr.desc" attribute of an existing generic_spct or derived-class object, or of a summary_generic_spct or derived-class object.

Usage

setInstrDesc(x, instr.desc)

instr_descriptor(x) <- value

Arguments

x

a generic_spct object or a summary_generic_spct object.

instr.desc, value

a list, instr_desc object, or NULL.

Value

x, with the value of its "instr.desc" attribute set to the value of the argument passed to instr.desc or to value.

Details

This function alters x itself by reference and in addition returns x invisibly. If x is not a generic_spct object, x is not modified, silently. If inst.desc = NULL is passed in the call, the attribute "instr.desc" is removed. This function is very rarely called from user code.

Note

The fields to be passed in the list instr.desc in part vary depending on the instrument brand and model.

See also

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