R/center.R

In vjilmari/vjihelpers: Toolbox of typical helper functions I need

#' Simple centering helper
#'
#' @param x Numeric variable.
#' @param na.rm Remove missing values (default TRUE)?
#'
#' @return Numeric variable centered around its mean.
#' @export
#'
#' @examples center(c(1, 2, 3, 5, 3, 2), na.rm = TRUE)
#' center(c(1, NA, NA, 5, 3, 2), na.rm = TRUE)
center <- function(x, na.rm = TRUE) {
  x - mean(x, na.rm = na.rm)
}