photobiology (version 0.13.0)

setWhenMeasured: Set the "when.measured" attribute

Description

Method to set by reference the "when.measured" attribute of an R object.

Usage

setWhenMeasured(x, when.measured, ...)
when_measured(x) <- value
# S3 method for default
setWhenMeasured(x, when.measured, ...)
# S3 method for generic_spct
setWhenMeasured(x, when.measured = lubridate::now(tzone = "UTC"), ...)
# S3 method for summary_generic_spct
setWhenMeasured(x, when.measured = lubridate::now(tzone = "UTC"), ...)
# S3 method for data.frame
setWhenMeasured(x, when.measured = lubridate::now(tzone = "UTC"), ...)
# S3 method for generic_mspct
setWhenMeasured(x, when.measured = lubridate::now(tzone = "UTC"), ...)

Value

x, with its "when.measured" set.

Arguments

x

an R object

when.measured, value

POSIXct to add as attribute, or a list of POSIXct.

...

Allows use of additional arguments in methods for other classes.

Methods (by class)

• setWhenMeasured(default): default

• setWhenMeasured(generic_spct): generic_spct

• setWhenMeasured(summary_generic_spct): summary_generic_spct

• setWhenMeasured(data.frame): data.frame

• setWhenMeasured(generic_mspct): generic_mspct

Details

This method alters x itself by reference and in addition returns x invisibly. If x is not an object of a supported class, x is not modified. If the arguments to "when.measured" or value are not a POSIXct object or NULL an error is triggered. A POSIXct describes an instant in time (date plus time-of-day plus time zone).

Be aware that lubridate::ymd() returns an incompatible Date object while lubridate::ymd_h(), lubridate::ymd_hm() and lubridate::ymd_hms() and similar functions return objects of class POSIXct acceptable as arguments for parameter when.measured.

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(), setInstrDesc(), setInstrSettings(), setSoluteProperties(), setWhatMeasured(), setWhereMeasured(), spct_attr2tb(), spct_metadata(), subset_attributes(), trimInstrDesc(), trimInstrSettings()

Examples

my.spct <- sun.spct
when_measured(my.spct)
when_measured(my.spct) <- lubridate::ymd_hms("2020-01-01 08:00:00")
when_measured(my.spct)
when_measured(my.spct) <- NULL
when_measured(my.spct)