Learn R Programming

photobiology (version 0.13.0)

getWhenMeasured: Get the "when.measured" attribute

Description

Method to read the "when.measured" attribute of an R object.

Usage

getWhenMeasured(x, ...)

when_measured(x, ...)

# S3 method for default getWhenMeasured(x, ...)

# S3 method for generic_spct getWhenMeasured(x, as.df = FALSE, ..., simplify = FALSE)

# S3 method for summary_generic_spct getWhenMeasured(x, as.df = FALSE, ..., simplify = FALSE)

# S3 method for data.frame getWhenMeasured(x, as.df = FALSE, ..., simplify = FALSE)

# S3 method for generic_mspct getWhenMeasured(x, ..., idx = "spct.idx", simplify = FALSE)

Value

a POSIXct object with date and time, or named list of such objects, or, on user request, a data frame.

Arguments

x

an R object

...

Allows use of additional arguments in methods for other classes.

as.df

logical If TRUE return a data frame instead of a list, when the value stored in the attribute is a list.

simplify

logical If all members share the same attribute value return one copy instead of a data.frame.

idx

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

Methods (by class)

  • getWhenMeasured(default): default

  • getWhenMeasured(generic_spct): generic_spct

  • getWhenMeasured(summary_generic_spct): summary_generic_spct

  • getWhenMeasured(data.frame): data.frame

  • getWhenMeasured(generic_mspct): generic_mspct

See Also

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

Examples

Run this code
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)

Run the code above in your browser using DataLab