tk_time_scale_template: Get and modify the Time Scale Template

View source: R/get-tk_get_time_scale_template.R

set_tk_time_scale_templateR Documentation

Get and modify the Time Scale Template

Description

Get and modify the Time Scale Template

Usage

set_tk_time_scale_template(.data)

get_tk_time_scale_template()

tk_time_scale_template()

Arguments

.data

A tibble with a "time_scale", "frequency", and "trend" columns.

Details

Used to get and set the time scale template, which is used by tk_get_frequency() and tk_get_trend() when period = "auto".

The predefined template is stored in a function tk_time_scale_template(). This is the default used by timetk.

Changing the Default Template

  • You can access the current template with get_tk_time_scale_template().

  • You can modify the current template with set_tk_time_scale_template().

Value

  • get_tk_time_scale_template(): Returns tibble containing the time scale template information.

  • set_tk_time_scale_template(): Returns nothing.

See Also

  • Automated Frequency and Trend Calculation: tk_get_frequency(), tk_get_trend()

Examples


get_tk_time_scale_template()

set_tk_time_scale_template(tk_time_scale_template())


timetk documentation built on Nov. 2, 2023, 6:18 p.m.