R: Low-level constructor for a tsibble object

build_tsibble {tsibble}

R Documentation

Low-level constructor for a tsibble object

Description

build_tsibble() creates a tbl_ts object with more controls. It is useful for creating a tbl_ts internally inside a function, and it allows developers to determine if the time needs ordering and the interval needs calculating.

Usage

build_tsibble(x, key = NULL, key_data = NULL, index, index2 = index,
  ordered = NULL, interval = TRUE, validate = TRUE,
  .drop = key_drop_default(x))

Arguments

`x`	A `data.frame`, `tbl_df`, `tbl_ts`, or other tabular objects.
`key`	Unquoted variable(s) that uniquely determine time indices. `NULL` for empty key, and works with tidy selector (e.g. `dplyr::starts_with()`).
`key_data`	A data frame containing key variables and `.rows`. When a data frame is supplied, the argument `key` will be ignored.
`index`	A bare (or unquoted) variable to specify the time index variable.
`index2`	A candidate of `index` to update the index to a new one when index_by. By default, it's identical to `index`.
`ordered`	The default of `NULL` arranges the key variable(s) first and then index from past to future. `TRUE` suggests to skip the ordering as `x` in the correct order. `FALSE` checks the ordering and may give a warning.
`interval`	`TRUE` automatically calculates the interval, and `FALSE` for irregular interval. Use the specified interval via `new_interval()` as is.
`validate`	`TRUE` suggests to verify that each key or each combination of key variables leads to unique time indices (i.e. a valid tsibble). If you are sure that it's a valid input, specify `FALSE` to skip the checks.
`.drop`	If `TRUE`, empty key groups are dropped.

Examples

# Prepare `pedestrian` to use a new index `Date` ----
pedestrian %>%
  build_tsibble(
    key = !! key_vars(.), index = !! index(.), index2 = Date,
    interval = interval(.)
  )

[Package tsibble version 0.8.2 Index]