geoSpectral (version 0.17.5)

spc.header2data: Copy header data into the @data slot

Description

Get the header metadata and place it inside the @data slot

Usage

spc.header2data(object, headerfield, dataname, compress, ...)
# S4 method for Spectra
spc.header2data(object, headerfield, dataname, compress = TRUE, ...)
# S4 method for list
spc.header2data(object, headerfield, dataname, compress = TRUE, ...)
# S4 method for SpcList
spc.header2data(object, headerfield, dataname, compress = TRUE, ...)

Arguments

object

A Spectra object

headerfield

character. Field name of the header to be copied.

dataname

character. Column name of @data slot to copy the incoming data.

compress

logical. Whether or not to compress data put into the header. See help of spc.data2header.

...

arguments to be passed to or from other methods

Value

object of class Spectra or SpcList

Details

If header element has length >1, its type is checked. If it is "character", its elements will be pasted using paste(...,collapse="|"). If it is another type, only the first element will be taken. For list and SpcList objects, the same procedure is repeated for all elements of the list containing Spectra objects. If dataname is missing, then it will be taken equal to headerfield.

Examples

# NOT RUN {
sp <- spc.example_spectra()
sp <- spc.updateheader(sp,"Zone", "ZoneA")
sp <- spc.header2data(sp, "Zone")
sp$Zone

# }