s_mean_se: Mean and standard error from collection of spectra

View source: R/mspct.mean.se.r

s_mean_seR Documentation

Mean and standard error from collection of spectra

Description

A method to compute the mean of values across members of a collections of spectra. Computes the mean at each wavelength across all the spectra in the collection returning a spectral object.

Usage

s_mean_se(x, na.rm, mult, ...)

## Default S3 method:
s_mean_se(x, na.rm = FALSE, mult = 1, ...)

## S3 method for class 'filter_mspct'
s_mean_se(x, na.rm = FALSE, mult = 1, ...)

## S3 method for class 'source_mspct'
s_mean_se(x, na.rm = FALSE, mult = 1, ...)

## S3 method for class 'response_mspct'
s_mean_se(x, na.rm = FALSE, mult = 1, ...)

## S3 method for class 'reflector_mspct'
s_mean_se(x, na.rm = FALSE, mult = 1, ...)

## S3 method for class 'calibration_mspct'
s_mean_se(x, na.rm = FALSE, mult = 1, ...)

## S3 method for class 'cps_mspct'
s_mean_se(x, na.rm = FALSE, mult = 1, ...)

## S3 method for class 'raw_mspct'
s_mean_se(x, na.rm = FALSE, mult = 1, ...)

Arguments

x

An R object Currently this package defines methods for collections of spectral objects.

na.rm

logical A value indicating whether NA values should be stripped before the computation proceeds.

mult

numeric number of multiples of standard error.

...

Further arguments passed to or from other methods.

Value

If x is a collection spectral of objects, such as a "filter_mspct" object, the returned object is of same class as the members of the collection, such as "filter_spct", containing the mean spectrum.

Methods (by class)

  • s_mean_se(default):

  • s_mean_se(filter_mspct):

  • s_mean_se(source_mspct):

  • s_mean_se(response_mspct):

  • s_mean_se(reflector_mspct):

  • s_mean_se(calibration_mspct):

  • s_mean_se(cps_mspct):

  • s_mean_se(raw_mspct):

Note

Trimming of extreme values and omission of NAs is done separately at each wavelength. Interpolation is not applied, so all spectra in x must share the same set of wavelengths.

Objects of classes raw_spct and cps_spct can contain data from multiple scans. This functions are implemented for these classes only for the case when all member spectra contain data for a single scan, or spliced into a single column in the case of cps_spct members.

See Also

See mean for the mean() method used for the computations.


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