tsibble (version 0.2.0)

tsibble: Create a tsibble object

Description

Create a tsibble object

Usage

tsibble(..., key = id(), index, regular = TRUE)

Arguments

...

A set of name-value pairs. The names of "key" and "index" should be avoided as they are used as the arguments.

key

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(). See below for details.

index

A bare (or unquoted) variable to specify the time index variable.

regular

Regular time interval (TRUE) or irregular (FALSE). TRUE finds the greatest common divisor of positive time distances as the interval.

Value

A tsibble object.

Index

The time indices are no longer an attribute (for example, the tsp attribute in a ts object), but preserved as the essential component of the tsibble. A few index classes, such as Date, POSIXct, and difftime, forms the basis of the tsibble, with new additions yearweek, yearmonth, and yearquarter representing year-week, year-month, and year-quarter respectively. zoo::yearmth and zoo::yearqtr are also supported. It is extensible to work with custom index, for example trading days and weekly data.

Key

Key variable(s) together with the index uniquely identifies each record. And key(s) also imposes the structure on a tsibble, which can be created via the id function as identifiers:

• None: an implicit variable id() resulting a univariate time series.

• A single variable: an explicit variable. For example, data(pedestrian) uses the id(Sensor) column as the key.

• Nested variables: a nesting of one variable under another. For example, data(tourism) contains two geographical locations: Region and State. Region is the lower level than State in Australia; in other words, Region is nested into State, which naturally forms a hierarchy. A vertical bar (|) is used to describe this nesting relationship, and thus Region | State. In theory, nesting can involve infinite levels, so is tsibble.

• Crossed variables: a crossing of one variable with another. For example, the geographical locations are crossed with the purpose of visiting (Purpose) in the data(tourism). A comma (,) is used to indicate this crossing relationship. Nested and crossed variables can be combined, such as data(tourism) using id(Region | State, Purpose).

These key variables describe the data structure.

Interval

The interval function returns the interval associated with the tsibble.

• Regular: the value and its time unit including "second", "minute", "hour", "day", "week", "month", "quarter", "year". An unrecognisable time interval is labelled as "unit".

• Irregular: as_tsibble(regular = FALSE) gives the irregular tsibble. It is marked with !.

• Unknown: if there is only one entry for each key variable, the interval cannot be determined (?).

Details

A tsibble is sorted by its key(s) first and index.

See Also

build_tsibble

Examples

# NOT RUN {
# create a tsibble w/o a key ----
tsbl1 <- tsibble(
  date = seq(as.Date("2017-01-01"), as.Date("2017-01-10"), by = 1),
  value = rnorm(10),
  key = id(), index = date
)
tsbl1

# create a tsibble with one key ----
tsbl2 <- tsibble(
  qtr = rep(yearquarter(seq(2010, 2012.25, by = 1 / 4)), 3),
  group = rep(c("x", "y", "z"), each = 10),
  value = rnorm(30),
  key = id(group), index = qtr
)
tsbl2

# }