new_interval {tsibble} | R Documentation |
Interval constructor for a tsibble
Description
-
new_interval()
creates an interval object. -
gcd_interval()
computes the greatest common divisor for the difference of numerics. -
is_regular_interval()
checks if the interval is regular.
Usage
new_interval(..., .regular = TRUE, .others = list())
is_regular_interval(x)
gcd_interval(x)
Arguments
... |
A set of name-value pairs to specify default interval units: "year", "quarter", "month", "week", "day", "hour", "minute", "second", "millisecond", "microsecond", "nanosecond", "unit". |
.regular |
Logical. |
.others |
A list name-value pairs that are not included in the |
x |
An interval. |
Value
an "interval" class
Examples
(x <- new_interval(hour = 1, minute = 30))
(y <- new_interval(.regular = FALSE)) # irregular interval
new_interval() # unknown interval
new_interval(.others = list(semester = 1)) # custom interval
is_regular_interval(x)
is_regular_interval(y)
gcd_interval(c(1, 3, 5, 6))
[Package tsibble version 1.1.5 Index]