Get and set labels of a hyperSpec object

Get and set labels of a hyperSpec object.

# S4 method for hyperSpec
labels(object, which = bquote(), drop = TRUE, ..., use.colnames = TRUE)

labels(object, which = NULL, ...) <- value

Arguments

object

a hyperSpec object

which

numeric or character to specify the label(s)

drop

if the result would be a list with only one element, should the element be returned instead?

...

ignored

use.colnames

should missing labels be replaced by column names of the extra data?

value

the new label(s)

Value

labels returns a list of labels. If drop is TRUE and the list contains only one element, the element is returned instead.

labels<- returns a hyperSpec object.

Details

value may be a list or vector of labels giving the new label for each of the entries specified by which.

The names of the labels are the same as the colnames of the data.frame. The label for the wavelength axis has the name .wavelength.

The labels should be given in a form ready for the text-drawing functions (see grDevices::plotmath()), e.g. as expression or a character.

See also

base::labels()

Author

C. Beleites

Examples

labels(faux_cell)
#> $x
#> expression("x position")
#> 
#> $y
#> expression("y position")
#> 
#> $region
#> [1] "region"
#> 
#> $spc
#> expression("intensity (arbitrary units)")
#> 
#> $.wavelength
#> expression(Delta * tilde(nu)/cm^-1)
#> 

labels(flu, "c") <- expression("/"("c", "mg / l"))