photobiology (version 0.9.25)

spread: Expanse

Description

A function that returns the expanse (max(x) - min(x)) for R objects.

Usage

spread(x, ...)
wl_expanse(x, ...)
expanse(x, ...)
# S3 method for default
expanse(x, ...)
# S3 method for numeric
expanse(x, ...)
# S3 method for waveband
expanse(x, ...)
# S3 method for generic_spct
expanse(x, ...)
# S3 method for generic_mspct
expanse(x, ..., idx = "spct.idx")

Arguments

x

an R object

...

not used in current version

idx

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

Value

A numeric value equal to max(x) - min(x). In the case of spectral objects wavelength difference in nm. For any other R object, according to available definitions of min and max.

Methods (by class)

• default: Default method for generic function

• numeric: Method for "numeric"

• waveband: Method for "waveband"

• generic_spct: Method for "generic_spct"

• generic_mspct: Method for "generic_mspct" objects.

Examples

# NOT RUN {
expanse(10:20)
expanse(sun.spct)
wl_expanse(sun.spct)

expanse(sun.spct)

# }