photobiology (version 0.13.0)

getWhereMeasured: Get the "where.measured" attribute

Description

Method to read the "where.measured" attribute of generic_spct, generic_mspct, summary_generic_spct, data.frame or a derived-class object.

Usage

getWhereMeasured(x, ...)
where_measured(x, ...)
# S3 method for default
getWhereMeasured(x, ...)
# S3 method for generic_spct
getWhereMeasured(x, ..., simplify = FALSE)
# S3 method for summary_generic_spct
getWhereMeasured(x, ..., simplify = FALSE)
# S3 method for generic_mspct
getWhereMeasured(
  x,
  ...,
  idx = "spct.idx",
  .bind.geocodes = TRUE,
  simplify = FALSE
)
# S3 method for data.frame
getWhereMeasured(x, ...)

Value

a data.frame with a single row and at least columns "lon" and "lat", unless expand is set to FALSE.

Arguments

x

a generic_spct object

...

Allows use of additional arguments in methods for other classes.

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.

.bind.geocodes

logical In the case of collections of spectra if .bind.geocodes = TRUE, the default, the returned value is a single geocode with one row for each member spectrum. Otherwise the individual geocode data frames are returned in a list column within a tibble.

Methods (by class)

• getWhereMeasured(default): default

• getWhereMeasured(generic_spct): generic_spct

• getWhereMeasured(summary_generic_spct): summary_generic_spct

• getWhereMeasured(generic_mspct): generic_mspct

• getWhereMeasured(data.frame): data.frame

See Also

Other measurement metadata functions: add_attr2tb(), getFilterProperties(), getHowMeasured(), getInstrDesc(), getInstrSettings(), getSoluteProperties(), getWhatMeasured(), getWhenMeasured(), get_attributes(), isValidInstrDesc(), isValidInstrSettings(), select_spct_attributes(), setFilterProperties(), setHowMeasured(), setInstrDesc(), setInstrSettings(), setSoluteProperties(), setWhatMeasured(), setWhenMeasured(), setWhereMeasured(), spct_attr2tb(), spct_metadata(), subset_attributes(), 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)
where_measured(my.spct) <- NULL
where_measured(my.spct)