sumGroups: Summarize the Group Membership of a Spectra or Spectra2D...

View source: R/sumGroups.R

sumGroupsR Documentation

Summarize the Group Membership of a Spectra or Spectra2D Object

Description

This function summarizes the group membership of a Spectra or Spectra2D object.

Usage

sumGroups(spectra)

Arguments

spectra

An object of S3 class ChemoSpec::Spectra() or ChemoSpec2D::Spectra2D().

Value

A data frame as follows. Note that if there are groups with no members these are dropped.

group

The name of the group.

no.

The number in the group.

color

The color assigned to the group.

symbol

The symbol assigned to the group. Spectra objects only.

alt.symbol

The alternative symbol assigned to the group. Spectra objects only.

Author(s)

Bryan A. Hanson (DePauw University).

See Also

To summarize the entire object, sumSpectra.

Examples

if (checkForPackageWithVersion("ChemoSpec", 6.0)) {
  library("ChemoSpec")
  data(SrE.IR)
  sumGroups(SrE.IR)
}

if (checkForPackageWithVersion("ChemoSpec2D", 0.5)) {
  library("ChemoSpec2D")
  data(MUD1)
  sumGroups(MUD1)
}

ChemoSpecUtils documentation built on May 31, 2023, 5:56 p.m.