Skip to contents

Constructor and methods to handle Raman spectra results

Source: R/class_RamanResults_Spectra.R
RamanResults_Spectra.Rd

The RamanResults_Spectra class is used to store Raman spectra results, including peak information and whether the spectra are averaged.

Usage

RamanResults_Spectra(
  spectra = list(),
  is_averaged = FALSE,
  peaks = list(),
  chrom_peaks = list()
)

# S3 method for class 'RamanResults_Spectra'
validate_object(x)

# S3 method for class 'RamanResults_Spectra'
show(x)

# S3 method for class 'RamanResults_Spectra'
x[i]

# S3 method for class 'RamanResults_Spectra'
x[[i]]

Arguments

spectra

A list of spectra data, where each element is a data.table representing a Raman spectrum.

is_averaged

A logical value indicating whether the spectra are averaged.

peaks

A list of peaks, where each element is a data.table representing the peaks for a corresponding spectrum.

chrom_peaks

A list where each element is a data.table representing the chromatographic peaks found in each spectrum, when a time dimension is present.

x

A RamanResults_Spectra object.

i

A character or numeric vector to perform subsetting. Check the specific method for details.

Methods (by generic)

  • validate_object(RamanResults_Spectra): Validate the RamanResults_Spectra object, returns NULL if valid.

  • show(RamanResults_Spectra): Show the RamanResults_Spectra object.

  • [: Subset the RamanResults_Spectra object by analyses. The argument i can be a character vector with the names of the analyses or a numeric vector with the indices of the analyses to keep.

  • [[: Extract a single analysis from the RamanResults_Spectra object. The argument i can be a character vector with the name of the analysis or a numeric vector with the index of the analysis to extract.

See also

Results for the parent class.