setWhereMeasured: Set the "where.measured" attribute

In photobiology: Photobiological Calculations

Set the "where.measured" attribute

Description

Function to set by reference the "where.measured" attribute of an existing generic_spct or an object of a class derived from generic_spct.

Usage

setWhereMeasured(x, where.measured, lat, lon, address, ...)

where_measured(x) <- value

## Default S3 method:
setWhereMeasured(x, where.measured, lat, lon, address, ...)

## S3 method for class 'generic_spct'
setWhereMeasured(x, where.measured = NA, lat = NA, lon = NA, address = NA, ...)

## S3 method for class 'summary_generic_spct'
setWhereMeasured(x, where.measured = NA, lat = NA, lon = NA, address = NA, ...)

## S3 method for class 'generic_mspct'
setWhereMeasured(x, where.measured = NA, lat = NA, lon = NA, address = NA, ...)

Arguments

x	a generic_spct object
where.measured, value	A one row data.frame such as returned by function geocode from package 'ggmap' for a location search.
lat	numeric Latitude in decimal degrees North
lon	numeric Longitude in decimal degrees West
address	character Human readable address
...	Allows use of additional arguments in methods for other classes.

Value

x

Methods (by class)

• setWhereMeasured(default): default

• setWhereMeasured(generic_spct): generic_spct

• setWhereMeasured(summary_generic_spct): summary_generic_spct

• setWhereMeasured(generic_mspct): generic_mspct

Note

This method alters x itself by reference and in addition returns x invisibly. If x is not a generic_spct or an object of a class derived from generic_spct, x is not modified. If where is 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). As expected passing NULL as argument for where.measured unsets the attribute.

Method for collections of spectra recycles the location information only if it is of length one.

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(), setWhenMeasured(), spct_attr2tb(), spct_metadata(), trimInstrDesc(), trimInstrSettings()

Examples

my.spct <- sun.spct
where_measured(my.spct)
where_measured(my.spct) <- data.frame(lon = 0, lat = -60)
where_measured(my.spct)

photobiology documentation built on Oct. 21, 2023, 1:06 a.m.