sts_check {MazamaTimeSeries} | R Documentation |
Check sts object for validity
Description
Checks on the validity of an sts object. If any test fails, this function will stop with a warning message.
Usage
sts_check(sts)
Arguments
sts |
sts object. |
Value
Returns TRUE
invisibly if the sts object is valid.
See Also
Examples
library(MazamaTimeSeries)
sts_check(example_sts)
# This would throw an error
if ( FALSE ) {
broken_sts <- example_sts
names(broken_sts) <- c('meta', 'bop')
sts_check(broken_sts)
}
[Package MazamaTimeSeries version 0.3.0 Index]