A relatively more flexible function to create a tbl_ts
object. It is useful
for creating a tbl_ts
internally inside a function, and it allows users to
determine if the time needs ordering and the interval needs calculating.
build_tsibble(x, key, index, groups = id(), regular = TRUE,
validate = TRUE, ordered = NULL, interval = NULL)
A data.frame
, tbl_df
, tbl_ts
, or other tabular objects.
Structural variable(s) that define unique time indices, used with
the helper id. If a univariate time series (without an explicit key),
simply call id()
.
A bare (or unquoted) variable to specify the time index variable.
Grouping variable(s).
Regular time interval (TRUE
) or irregular (FALSE
). TRUE
finds the minimal time span as the interval.
TRUE
suggests to verify that each key or each combination
of key variables lead to unique time indices (i.e. a valid tsibble). It will
also make sure that the nested variables are arranged from lower level to
higher, if nested variables are passed to key
. If you are sure that it's a
valid input, specify FALSE
to skip the checks.
The default of NULL
arranges the key variable(s) first and
then index in ascending order. TRUE
suggests to skip the ordering as x
in
the correct order. FALSE
also skips the ordering but gives a warning instead.
NULL
computes the interval. Use the specified interval as
is, if an class of interval
is supplied.