rmDerivedSpct: Remove "generic_spct" and derived class attributes.

Description Usage Arguments Value Note See Also Examples

View source: R/spct.classes.r

Description

Removes from a spectrum object the class attributes "generic_spct" and any derived class attribute such as "source_spct". This operation is done by reference!

Usage

1
rmDerivedSpct(x, keep.classes = NULL)

Arguments

x

an R object.

keep.classes

character vector Names of classes to keep. Can be used to retain base class "generic_spct".

Value

A character vector containing the removed class attribute values. This is different to the behaviour of function unlist in base R!

Note

If x is an object of any of the spectral classes defined in this package, this function changes by reference the spectrum object into the underlying data.frame object. Otherwise, it just leaves x unchanged.

This function alters x itself by reference. If x is not a generic_spct object, x is not modified.

See Also

Other set and unset spectral class functions: setGenericSpct()

Examples

1
2
3
4
5
my.spct <- sun.spct
removed <- rmDerivedSpct(my.spct)
removed
class(sun.spct)
class(my.spct)

photobiology documentation built on Aug. 28, 2020, 1:11 a.m.