R: Set the "time.unit" attribute of an existing source

setTimeUnit {photobiology}

R Documentation

Set the "time.unit" attribute of an existing source_spct object

Description

Function to set by reference the "time.unit" attribute

Usage

setTimeUnit(x, time.unit = c("second", "hour", "day", "exposure", "none"),
  override.ok = FALSE)

Arguments

`x`	a source_spct object
`time.unit`	a character string, either "second", "hour", "day", "exposure" or "none", or a lubridate::duration
`override.ok`	logical Flag that can be used to silence warning when overwriting an existing attribute value (used internally)

Value

Note

This function alters x itself by reference and in addition returns x invisibly. If x is not a source_spct or response_spct object, x is not modified. The behaviour of this function is 'unusual' in that the default for parameter time.unit is used only if x does not already have this attribute set. time.unit = "hour" is currently not fully supported.

Examples

my.spct <- sun.spct
setTimeUnit(my.spct, time.unit = "second")
setTimeUnit(my.spct, time.unit = lubridate::duration(1, "seconds"))

[Package photobiology version 0.9.21 Index]