setHowMeasured: Set the "how.measured" attribute

View source: R/spct.metadata.r

setHowMeasuredR Documentation

Set the "how.measured" attribute

Description

Function to set the "how.measured" attribute of an existing generic_spct, generic_mspct, summary_generic_spct, data.frame or a derived-class object.

Usage

setHowMeasured(x, ...)

how_measured(x) <- value

## Default S3 method:
setHowMeasured(x, how.measured, ...)

## S3 method for class 'generic_spct'
setHowMeasured(x, how.measured, ...)

## S3 method for class 'summary_generic_spct'
setHowMeasured(x, how.measured, ...)

## S3 method for class 'data.frame'
setHowMeasured(x, how.measured, ...)

## S3 method for class 'generic_mspct'
setHowMeasured(x, how.measured, ...)

Arguments

x

a R object

...

Allows use of additional arguments in methods for other classes.

how.measured, value

a list or a character string.

Value

x modified by reference.

Methods (by class)

  • setHowMeasured(default): default

  • setHowMeasured(generic_spct): generic_spct

  • setHowMeasured(summary_generic_spct): summary_generic_spct

  • setHowMeasured(data.frame): data.frame

  • setHowMeasured(generic_mspct): generic_mspct

Note

This function alters x itself by reference and in addition returns x invisibly. If x is not an object of a supported class, x is silently returned unchanged.

See Also

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

Examples


my.spct <- sun.spct
how_measured(my.spct)
how_measured(my.spct) <- "simulated with a radiation transfer model"
how_measured(my.spct)


photobiology documentation built on April 4, 2025, 4:37 a.m.