R/center.R

Defines functions center

Documented in center

#' @title Data Centering
#'
#' @author Christian L. Goueguel
#'
#' @description
#' Function to perform mean-centering or median-centering on a numeric matrix or
#' data frame.
#'
#' @details
#' Mean-centering calculates the mean of each column and subtracts this from
#' the column. Median-centering is very similar to
#' mean-centering except that the reference point is the median of each column
#' rather than the mean.
#'
#' @param x A numeric matrix or data frame.
#' @param method A character string specifying the centering method, either
#' "mean" or "median".
#' @param drop_na A logical value indicating whether to ignore missing values
#' (NA) when computing the column means or medians. Missing values are kept
#' in the output.
#' @param drop.na `r lifecycle::badge("deprecated")` Use `drop_na`.
#'
#' @return A numeric matrix with the same dimensions as the input, with
#' columns centered according to the specified method. The column centers
#' are stored in the `"center"` attribute.
#'
#' @export center
#'
#' @examples
#' data(forageLIBS)
#' spectra <- forageLIBS[-(1:14)]  # the spectral channels
#' center(spectra)[1:3, 1:4]
#' center(spectra, method = "median")[1:3, 1:4]
center <- function(x, method = "mean", drop_na = FALSE,
                   drop.na = deprecated()) {
  drop_na <- renamed_arg(drop.na, drop_na, "center", "drop.na", "drop_na")

  if (!is.numeric(x) && !is.data.frame(x)) {
    stop("Input must be a numeric matrix or data frame")
  }
  check_flag(drop_na, "drop_na")
  x <- as_numeric_matrix(x, "x")

  centers <- switch(
    method,
    mean = colMeans(x, na.rm = drop_na),
    median = col_medians(x, na.rm = drop_na),
    stop("Invalid method. Must be either 'mean' or 'median'")
  )

  xc <- sweep(x, 2, centers)
  attr(xc, "center") <- centers
  return(xc)
}

Try the specProc package in your browser

Any scripts or data that you put into this service are public.

specProc documentation built on Nov. 20, 2026, 5:11 p.m.