R/harmean.R

Defines functions harmean

Documented in harmean

#' Calculate a harmonic mean
#' 
#' @param x An invertable R object.
#' @param ... further arguments passed to \code{\link{mean}}
#' @export
#' @seealso \code{\link{geomean}} and \code{\link{mean}}
harmean <- function(x, ...)
{
  return(1/(mean(1/x, ...)))
}
rogiersbart/rtoolz documentation built on Aug. 20, 2020, 2:48 p.m.