build_tsibble_meta

A <code>data.frame</code>, <code>tbl_df</code>, <code>tbl_ts</code>, or other tabular objects.

Variable(s) that define unique time indices, used in conjunction
with the helper <code><a rd-options="=id" href="/link/id()?package=tsibble&version=0.6.1&to=%3Did" data-mini-rdoc="=id::id()">id()</a></code>. If a univariate time series (without an explicit key),
simply call <code>id()</code>.

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

index

A candidate of <code>index</code> to update the index to a new one when
<a rd-options="" href="/link/index_by?package=tsibble&version=0.6.1" data-mini-rdoc="tsibble::index_by">index_by</a>. By default, it's identical to <code>index</code>.

index2

Regular time interval (<code>TRUE</code>) or irregular (<code>FALSE</code>). The
interval is determined by the greatest common divisor of index column, if <code>TRUE</code>.

regular

The default of <code>NULL</code> arranges the key variable(s) first and
then index from past to future. <code>TRUE</code> suggests to skip the ordering as <code>x</code> in
the correct order. <code>FALSE</code> also skips the ordering but gives a warning instead.

ordered

<code>NULL</code> computes the interval. Use the specified interval via
<code><a rd-options="=new_interval" href="/link/new_interval()?package=tsibble&version=0.6.1&to=%3Dnew_interval" data-mini-rdoc="=new_interval::new_interval()">new_interval()</a></code> as is, if an class of <code>interval</code> is supplied.

interval

<code>build_tsibble_meta()</code> assigns the attributes to an object, assuming this
object is a valid tsibble.

internal

Provides a 'tbl_ts' class (the 'tsibble') to store
and manage temporal data in a data-centric format, which is
built on top of the 'tibble'. The 'tsibble' aims at easily
manipulating and analysing temporal data, including counting and
filling time gaps, aggregate over calendar periods, performing rolling
window calculations, and etc.

Earo Wang

tsibble

Tidy Temporal Data Frames and Tools

Di Cook

Rob Hyndman

Mitchell O'Hara-Wild

build_tsibble_meta function

Variable(s) that define unique time indices, used in conjunction
with the helper <code><a rd-options='=id' href='id()'>id()</a></code>. If a univariate time series (without an explicit key),
simply call <code>id()</code>.

A candidate of <code>index</code> to update the index to a new one when
<a rd-options='' href='index_by'>index_by</a>. By default, it's identical to <code>index</code>.

<code>NULL</code> computes the interval. Use the specified interval via
<code><a rd-options='=new_interval' href='new_interval()'>new_interval()</a></code> as is, if an class of <code>interval</code> is supplied.

build_tsibble_meta: Low-level constructor to a tsibble object

Description

Usage

Arguments