s_mean_se_band: Mean plus and minus standard error from collection of spectra

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

s_mean_se_bandR Documentation

Mean plus and minus standard error from collection of spectra

Description

Method to compute the "parallel" mean and limits based on SEM. The spectral values are summarised across members of a collection of spectra or of a spectral object containing multiple spectra in long form.

Usage

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

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

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

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

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

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

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

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

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

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

Arguments

x

An R object.

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.

Details

Method specializations compute the mean and limits based on SEM at each wavelength across a group of spectra stored in an object of one of the classes defined in package 'photobiology'. 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. An error is triggered if this condition is nor fulfilled. The value passed as argument to 'mult' can be used to estimate a confidence interval for each mean value.

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 summary spectrum, with variables with names tagged for summaries other than mean or median.

Methods (by class)

  • s_mean_se_band(default):

  • s_mean_se_band(generic_spct):

  • s_mean_se_band(filter_mspct):

  • s_mean_se_band(source_mspct):

  • s_mean_se_band(response_mspct):

  • s_mean_se_band(reflector_mspct):

  • s_mean_se_band(calibration_mspct):

  • s_mean_se_band(cps_mspct):

  • s_mean_se_band(raw_mspct):

Note

Objects of classes raw_spct and cps_spct can contain data from multiple scans in multiple variables or "columns". The methods accept as arguments objects of these classes only if spectra contain data for a single spectrometer scan. In the case of cps_spct objects, a single column can also contain data from multiple scans spliced into a single variable.

See Also

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

Examples

s_mean_se_band(sun_evening.mspct)


photobiology documentation built on April 4, 2025, 4:37 a.m.