R/prepare_metric.R

In lantrns-analytics/rproductanalytics: A Suite of Product Performance Utilities

#' Prepare Product's Metric for Analysis
#'
#' @param product_data Dataset to use. Should include metric field and already be ordered.
#' @param window_width Window to calculate rolling mean
#'
#' @return Metric with baselines to compare metric with
#' @export
#'
#' @examples
prepare_metric <- function(product_data, baseline_window_width) {
  metric_baseline = data.frame(rollapply(product_data$metric,baseline_window_width,mean,align='right',fill=NA))
  names(metric_baseline) <- c("metric_baseline")

  product_data <- product_data %>%
    bind_cols(metric_baseline) %>%
    mutate(metric_baseline_diff = metric - metric_baseline,
           metric_baseline_diff_perc = (metric - metric_baseline) / metric_baseline)
}