R/geomean.R

In mjdufort/miscHelpers: Miscellaneous helper functions

#' Calculate the geometric mean of a numeric vector
#'
#' Calculate the geometric mean of a numeric vector, passing arguments on to \code{mean}.
#' @param x numeric vector. All elements must be positive, or an error is thrown. Geometric mean is defined only where all elements are positive.
#' @param ... optional arguments, passed to \code{mean}. \code{na.rm} is particularly useful.
#' @export
#' @return numeric, the value of the geometric mean
#' @usage geomean(x, ...)
geomean <- function(x, ...) {
  if (any(x <= 0)) stop("Geometric mean cannot be computed for vectors with 0 or negative values.")
  exp(mean(log(x), ...))
}