From aed160d7f0eaf5865e2bd9bf6c4b1c9d7b13d911 Mon Sep 17 00:00:00 2001 From: Ranke Johannes Date: Wed, 31 Jan 2024 13:16:17 +0100 Subject: Reorganise data generation - Use inst/data_generation for R code generating data as in some of my other packages - data/*.RData files were checked using https://github.com/jranke/dotfiles/blob/main/bin/rda_diff contents were not changed - Remove ChangeLog, the history is in the git logs - Update docs and some links contained therein - use \doi{} markup - Move logs to log directory --- docs/reference/geomean.html | 156 +++++++++++++------------------------------- 1 file changed, 47 insertions(+), 109 deletions(-) (limited to 'docs/reference/geomean.html') diff --git a/docs/reference/geomean.html b/docs/reference/geomean.html index 34befc3..540b33b 100644 --- a/docs/reference/geomean.html +++ b/docs/reference/geomean.html @@ -1,68 +1,16 @@ - - - - - - - -Calculate the geometric mean — geomean • pfm - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Calculate the geometric mean — geomean • pfm - - - - - - - - - - - - - - + + -
-
- -
- -
+

Calculate the geometric mean

@@ -111,64 +45,68 @@ If at least one element of the vector is 0, it returns 0." />

Based on some posts in a thread on Stackoverflow -http://stackoverflow.com/questions/2602583/geometric-mean-is-there-a-built-in +http://stackoverflow.com/questions/2602583/geometric-mean-is-there-a-built-in This function returns NA if NA values are present and na.rm = FALSE (default). If negative values are present, it gives an error message. If at least one element of the vector is 0, it returns 0.

- 
geomean(x, na.rm = FALSE)
+
+ 
geomean(x, na.rm = FALSE)
+
-

Arguments

- - - - - - - - - - -
x

Vector of numbers

na.rm

Should NA values be omitted?

+
+

Arguments

+
x
+

Vector of numbers

-

Value

-

The geometric mean

+
na.rm
+

Should NA values be omitted?

-

Examples

- 
geomean(c(1, 3, 9))
#> [1] 3
geomean(c(1, 3, NA, 9))
#> [1] NA
if (FALSE) geomean(c(1, -3, 9)) # returns an error
-
- +
+

Value

+ +

The geometric mean

+
+

Author

Johannes Ranke

+
+ +
+

Examples

+ 
geomean(c(1, 3, 9))
+#> [1] 3
+geomean(c(1, 3, NA, 9))
+#> [1] NA
+geomean(c(1, -3, 9)) # returns an error
+#> Error in geomean(c(1, -3, 9)): Only defined for positive numbers
+
+
+
-
- - + + -- cgit v1.2.1