R/ts-splits-plot.R

In spsanderson/healthyR.ts: The Time Series Modeling Companion to 'healthyR'

#' Time Series Splits Plot
#'
#' @author Steven P. Sanderson II, MPH
#'
#' @description
#' Sometimes we want to see the training and testing data in a plot. This is a
#' simple wrapper around a couple of functions from the `timetk` package.
#'
#' @seealso
#'   * \url{https://business-science.github.io/timetk/reference/index.html#section-cross-validation-plan-visualization-resample-sets-} (timetk)
#'   * \url{https://business-science.github.io/timetk/reference/plot_time_series_cv_plan.html}(tk_time_sers_cv_plan)
#'   * \url{https://business-science.github.io/timetk/reference/plot_time_series_cv_plan.html}(plot_time_series_cv_plan)
#'
#' @details
#' You should already have a splits object defined. This function takes in three
#' parameters, the splits object, a date column and the value column.
#'
#' @param .splits_obj The predefined splits object.
#' @param .date_col The date column for the time series.
#' @param .value_col The value column of the time series.
#'
#' @examples
#' suppressPackageStartupMessages(library(modeltime))
#' suppressPackageStartupMessages(library(timetk))
#' suppressPackageStartupMessages(library(dplyr))
#'
#' data <- ts_to_tbl(AirPassengers) %>%
#'   select(-index)
#'
#' splits <- time_series_split(
#'     data
#'     , date_col
#'     , assess = 12
#'     , skip = 3
#'     , cumulative = TRUE
#' )
#'
#' ts_splits_plot(
#'     .splits_obj = splits,
#'     .date_col   = date_col,
#'     .value_col  = value
#' )
#
#'
#' @return
#' A time series cv plan plot
#'
#' @name ts_splits_plot
NULL

#' @export
#' @rdname ts_splits_plot

ts_splits_plot <- function(.splits_obj, .date_col, .value_col){

    # * Tidyeval ----
    date_col_var_expr  <- rlang::enquo(.date_col)
    value_col_var_expr <- rlang::enquo(.value_col)

    # Splits Object
    splits_object <- .splits_obj

    # * Plot out splits
    plt <- splits_object %>%
        timetk::tk_time_series_cv_plan() %>%
        timetk::plot_time_series_cv_plan(
            .date_var = {{ date_col_var_expr }}
            , .value  = {{ value_col_var_expr }}
        )

    # * Return ----
    return(plt)

}