From a76221d87485029444c8e684022ca606a0c7e68d Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Wed, 18 Jan 2017 22:41:01 +0100 Subject: Update static docs using pkgdown - Add _pkgdown.yml for a structured function/data reference - Make seealso links active - Make mkinfit calls quiet - Use pkgdown branch from pull request hadley/pkgdown#229 to have topics ordered --- docs/reference/geomean.html | 127 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 127 insertions(+) create mode 100644 docs/reference/geomean.html (limited to 'docs/reference/geomean.html') diff --git a/docs/reference/geomean.html b/docs/reference/geomean.html new file mode 100644 index 0000000..4634f99 --- /dev/null +++ b/docs/reference/geomean.html @@ -0,0 +1,127 @@ + + + + + + + + +Calculate the geometric mean — geomean • pfm + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+

Calculate the geometric mean

+
+ + +

Based on some posts in a thread on Stackoverflow +http://stackoverflow.com/questions/2602583/geometric-mean-is-there-a-built-in +This function checks for negative values, removes NA values per default and +returns 0 if at least one element of the vector is 0.

+ + + 
geomean(x, na.rm = TRUE)
+ +

Arguments

+
+
x
+
Vector of numbers
+
na.rm
+
Should NA values be omitted?
+
+ +

Value

+ +

The geometric mean

+ + +

Examples

+ 
geomean(c(1, 3, 9))
#> [1] 3
geomean(c(1, 3, NA, 9))
#> [1] 3
## Not run: geomean(c(1, -3, 9)) # returns an error
+
+ +
+ + +
+ + + -- cgit v1.2.1