aggregate_spectra: Aggregates spectral and data information

In spectacles: Storing, Manipulating and Analysis Spectroscopy and Associated Data

Aggregates spectral and data information

Description

Aggregates spectral and data information of a Spectra object using a user-defined function

Usage

## S4 method for signature 'Spectra'
aggregate_spectra(obj, fun = mean, ...)

## S4 method for signature 'SpectraDataFrame'
aggregate_spectra(obj, fun = mean, id = NULL, ...)

Arguments

obj	see below
fun	see below
...	see below
id	see below

Details

For SpectraDataFrame objects, associated data is also aggregated using the function provided by the fun option. Additionally, the method for SpectraDataFrame has an id option that allows to specify an attribute which will be used to split the object, apply sequentially the fun function, and recombine the results in an unique object.

Value

An object of the same class as obj

Methods

x=Spectra

aggregate_spectra(obj, fun=mean, ...)

	obj	A Spectra object
	fun	An aggregation function
	...	Expressions evaluated in the context of fun

x=SpectraDataFrame

aggregate_spectra(obj, fun=mean, id=NULL, ...)

	obj	A SpectraDataFrame object
	fun	An aggregation function
	id	Attribute(s) to split the object (character vector)
	...	Expressions evaluated in the context of fun

Author(s)

Pierre Roudier [e-mail]

See Also

apply_spectra

Examples

# Loading example data
data(australia)
spectra(australia) <- sr_no ~ ... ~ 350:2500

# Aggregation on the whole collection
m <- aggregate_spectra(australia, fun = mean)
plot(m)

# Aggregation factor-wise

# Generate some kind of factor
australia$fact <- sample(
  LETTERS[1:3], 
  size = nrow(australia), 
  replace = TRUE
)
m <- aggregate_spectra(australia, fun = mean, id = 'fact')
plot(m)

spectacles documentation built on July 10, 2023, 1:59 a.m.