timetk: plot_time_series_cv_plan – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

plot_time_series_cv_plan

Visualize a Time Series Resample Plan

Description

The plot_time_series_cv_plan() function provides a visualization for a time series resample specification (rset) of either rolling_origin or time_series_cv class.

Usage

plot_time_series_cv_plan(
  .data,
  .date_var,
  .value,
  ...,
  .smooth = FALSE,
  .title = "Time Series Cross Validation Plan"
)

Arguments

`.data`	A time series resample specification of of either `rolling_origin` or `time_series_cv` class or a data frame (tibble) that has been prepared using `tk_time_series_cv_plan()`.
`.date_var`	A column containing either date or date-time values
`.value`	A column containing numeric values
`...`	Additional parameters passed to `plot_time_series()`
`.smooth`	Logical - Whether or not to include a trendline smoother. Uses See `smooth_vec()` to apply a LOESS smoother.
`.title`	Title for the plot

Details

Resample Set

A resample set is an output of the timetk::time_series_cv() function or the rsample::rolling_origin() function.

Examples

library(tidyverse)
library(tidyquant)
library(rsample)
library(timetk)

FB_tbl <- FANG %>%
    filter(symbol == "FB") %>%
    select(symbol, date, adjusted)

resample_spec <- time_series_cv(
    FB_tbl,
    initial = "1 year",
    assess  = "6 weeks",
    skip    = "3 months",
    lag     = "1 month",
    cumulative  = FALSE,
    slice_limit = 6
)

resample_spec %>% tk_time_series_cv_plan()

resample_spec %>%
    tk_time_series_cv_plan() %>%
    plot_time_series_cv_plan(
        date, adjusted, # date variable and value variable
        # Additional arguments passed to plot_time_series(),
        .facet_ncol = 2,
        .line_alpha = 0.5,
        .interactive = FALSE
    )

timetk

A Tool Kit for Working with Time Series in R

v2.6.1

GPL (>= 3)

Authors

Matt Dancho [aut, cre], Davis Vaughan [aut]

Initial release