calcGM {PBSmodelling}

Calculate the Geometric Mean, Allowing for Zeroes

Description

Calculate the geometric mean of a numeric vector, possibly excluding zeroes and/or adding an offset to compensate for zero values.

Usage

calcGM(x, offset = 0, exzero = TRUE)

Arguments

x

vector of numbers

offset

value to add to all components, including zeroes

exzero

if TRUE, exclude zeroes (but still add the offset)

Value

Geometric mean of the modified vector x + offset

Note

NA values are automatically removed from x

Author(s)

Rowan Haigh, Pacific Biological Station, Fisheries and Oceans Canada, Nanaimo BC

Examples

local(envir=.PBSmodEnv,expr={
  calcGM(c(0,1,100))
  calcGM(c(0,1,100),offset=0.01,exzero=FALSE)
})