Add a geometric mean function

1 files changed, 31 insertions, 0 deletions

diff --git a/pkg/man/geomean.Rd b/pkg/man/geomean.Rd
new file mode 100644
index 0000000..42a30c4
--- /dev/null
+++ b/pkg/man/geomean.Rd
@@ -0,0 +1,31 @@
+% Generated by roxygen2 (4.1.0.9001): do not edit by hand
+% Please edit documentation in R/geomean.R
+\name{geomean}
+\alias{geomean}
+\title{Calculate the geometric mean}
+\usage{
+geomean(x, na.rm = TRUE)
+}
+\arguments{
+\item{x}{Vector of numbers}
+
+\item{na.rm}{Should NA values be omitted?}
+}
+\value{
+The geometric mean
+}
+\description{
+Based on some posts in a thread on Stackoverflow
+\url{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.
+}
+\examples{
+geomean(c(1, 3, 9))
+geomean(c(1, 3, NA, 9))
+\dontrun{geomean(c(1, -3, 9)) # returns an error}
+}
+\author{
+Johannes Ranke
+}
+