R/moving_average.R

In SamLoontjens/HandlingLicorFiles: Handling LI-6400 and LI-6800 output files

#' A function that calculates a moving average of a column or vector.
#'
#' @description
#'   A function that calculates a moving or rolling average of a
#'   column or vector.
#'   It returns the new column or vector that is averaged.
#' @param column A column or vector to be averaged.
#' @param averaging_width the amount of neighbouring values to average.
#' @param sides One or two sided rolling average, default is two.
#' @export
#' @return
#' Returns the new column or vector that is moving averaged
#' to overwrite the old one or add as a new column.
#' @examples
#' mydata$A <- moving_average(mydata$A, 5, 2)
#'
#' or
#' mydata$avrA <- moving_average(mydata$A, 5, 2)
#'
moving_average <- function(column, averaging_width = 5, sides = 2){

  #Moving or rolling average
  return(stats::filter(x = column, filter = rep(1/averaging_width, averaging_width), sides = sides))
}