R/geometricMean.R

In acidgenomics/bioverbs: Acid Genomics Generics

#' Geometric mean
#'
#' The geometric mean is the nth root of n products or e to the mean log of `x`.
#'
#' Useful for describing non-normal (i.e. geometric) distributions.
#'
#' @export
#' @inheritParams AcidRoxygen::params
#'
#' @return `numeric`.
#'
#' @examples
#' showMethods("geometricMean")
setGeneric(
    name = "geometricMean",
    def = function(x, ...) {
        standardGeneric("geometricMean")
    }
)