geomMean: geomMean
In stefanavey/aveytoolkit: Toolkit of Helper Functions

Description Usage Arguments Details Value Author(s) References See Also Examples

Calculate the geometric mean

1	geomMean(x, na.rm = FALSE, zero.propagate = TRUE)

`x`	a vector of non-negative numeric values.
`na.rm`	(optional) whether to remove `NA` values before calculation. Default is `FALSE`
`zero.propagate`	(optional) logical specifying whether zeros should be progated such that if there are zeros in 'x' 0 should be returned.

This function handles negative values by returning 'NaN' and zeros by returning '0' by default.

the geometric mean of x

Paul McMurdie, Stefan Avey

http://stackoverflow.com/questions/2602583/geometric-mean-is-there-a-built-in

exp sum log

x <- 1:10
x2 <- c(x, NA)
x3 <- -5:5
x4 <- 0:4

geomMean(x)
mean(x)

geomMean(x2)
mean(x2)

geomMean(x2, na.rm = TRUE)
mean(x2, na.rm = TRUE)

## NaN because because x3 contains negative values ##
geomMean(x3)
mean(x3)

geomMean(x4)
geomMean(x4, zero.propagate = FALSE)
mean(x4)