extradata: extradata of a colorSpec object

Description Usage Arguments Details Value Note See Also

View source: R/colorSpec.R

Description

Retrieve or set the extradata of a colorSpec object.

Usage

1
2
3
4
5
## S3 method for class 'colorSpec'
extradata(x)

## S3 replacement method for class 'colorSpec'
extradata(x,add=FALSE) <- value

Arguments

x

a colorSpec object with M spectra

value

a data.frame with M rows. It is OK for value to have 0 columns, and value can also be NULL; see add.

add

If add is FALSE, then any existing extradata is discarded and replaced by value, except when value is NULL when x is left with no extradata.
If add is TRUE, then value is appended to the existing extradata, except when value is NULL when x is left unchanged.

Details

If the organization of x is not 'df.row', then extradata cannot be stored in x and the assignment is ignored, with a warning. First change the organization to 'df.row', and then assign the extradata.

If the organization of x is 'df.row', but value does not have the right number of rows, the assignment is ignored, with a warning.

Value

extradata(x) returns a data.frame with M rows, where M is the number of spectra in x. The rownames are set to the specnames of x. If there is no extra data then the number of columns in this data.frame is 0.

Note

Do not confuse extradata and metadata.
metadata is unstructured data that is attached to the entire colorSpec object. extradata is structured data, with a row of data for each spectrum in the object.

See Also

metadata, organization


colorSpec documentation built on Nov. 19, 2018, 5:06 p.m.