photobiology (version 0.14.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,
  ...,
  idx = getIdFactor(x),
  simplify = TRUE,
  .bind.geocodes = TRUE
)
# S3 method for summary_generic_spct
getWhereMeasured(
  x,
  ...,
  idx = getIdFactor(x),
  simplify = TRUE,
  .bind.geocodes = TRUE
)
# 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.

idx

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

simplify

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

.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

getWhereMeasured(sun.spct)
getWhereMeasured(sun_evening.spct)
getWhereMeasured(sun_evening.spct, simplify = TRUE)
getWhereMeasured(sun_evening.mspct)
getWhereMeasured(sun_evening.mspct, .bind.geocodes = FALSE)
getWhereMeasured(sun_evening.mspct, simplify = TRUE)
getWhereMeasured(sun_evening.mspct, simplify = FALSE)

getWhereMeasured(summary(sun.spct))
getWhereMeasured(summary(sun_evening.spct))
getWhereMeasured(summary(sun_evening.mspct, expand = "each")[[1]])

getWhereMeasured(polyester.spct)