summary: Summary of a collection of spectra

summaryR Documentation

Summary of a collection of spectra

Description

Method of generic function summary for objects of spectral collection classes.

Methods of generic function summary for objects of spectral classes.

Usage

## S3 method for class 'generic_mspct'
summary(
  object,
  maxsum = 7,
  digits = max(3, getOption("digits") - 3),
  idx = "spct.idx",
  which.metadata = NULL,
  ...
)

## S3 method for class 'generic_spct'
summary(object, maxsum = 7, digits = max(3, getOption("digits") - 3), ...)

Arguments

object

An object of one of the spectral classes for which a summary is desired

maxsum

integer Indicates how many levels should be shown for factors.

digits

integer Used for number formatting with format().

idx

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

which.metadata

character vector Names of attributes to retrieve, or "none" or "all".

...

additional arguments affecting the summary produced, ignored in current version

Value

A summary object matching the class of object.

A summary object matching the class of object.

Examples

summary(sun.spct)

summary(sun.spct)


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