Simple Moving Average plot `ts_sma_plot` about healthyr.ts

[spsanderson]

library(timetk)
library(dplyr)

ts_sma_plot <- function(.data, .sma_order, .func = mean, .align = "center", 
                        .partial = FALSE, .multi_plot = FALSE,
                        .interactive = FALSE) {
  
  # * Tidyeval ----
  # slidify_vec parameters
  sma_vec      <- as.vector(.sma_order)
  sma_fun      <- .func
  sma_align    <- stringr::str_to_lower(as.character(.align))
  sma_partial  <- as.logical(.partial)
  multi_plot   <- as.logical(.multi_plot)
  interactive  <- as.logical(.interactive)
  
  # * Checks ----
  if(!sma_align %in% c("center","left","right")){
    stop(call. = FALSE, "(.align) must be either 'center','left', or 'right'")
  }
  
  if(!is.numeric(sma_vec)){
    stop(call. = FALSE, "(.sma_order) must be all numeric values, c(1,2,3,...)")
  }
  
  if(!is.logical(sma_partial) & !is.logical(multi_plot) & !is.logical(interactive)){
    stop(call. = FLASE, "(.partial) (.multi_plot) and (.interactive) must all be logical values.")
  }
  
  # Get data object
  ts_obj <- .data
  
  # Get data and try to coerce to tibble
  # We do this because we use timetk::slidify_vec
  if(stats::is.ts(ts_obj) | stats::is.mts(ts_obj) | xts::is.xts(ts_obj) | zoo::is.zoo(ts_obj)){
    message("Attempting to coerce to a tibble.")
    ts_tbl <- timetk::tk_tbl(ts_obj) # change to internal ts_to_tbl() func
  } else {
    ts_tbl <- ts_obj
  }
  
  # * Loop through periods ----
  df <- data.frame(matrix(ncol = 0, nrow = 0))
  for(i in sma_vec){
    ret_tmp <- ts_tbl %>%
      dplyr::mutate(sma_order = i) %>%
      dplyr::mutate(sma_value = timetk::slidify_vec(
        .x       = value,
        .f       = sma_fun,
        .period  = i,
        .align   = sma_align,
        .partial = sma_partial
      ))
    
    df <- base::rbind(df, ret_tmp)
  }
  
  # * Plots ----
  
  # * Return ----
  return(df)
  
}