aboutsummaryrefslogtreecommitdiff
path: root/pkg/man
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2015-04-24 02:21:04 +0200
committerJohannes Ranke <jranke@uni-bremen.de>2015-04-24 02:22:08 +0200
commit7d2096855edcc196629c1c7a9983a56ec6addd1e (patch)
treed4adf4a7c2db89b0ca816c9ae5973bab1317c88b /pkg/man
parentbcfe0af7970efe36c3aa661e89953fbe3689c310 (diff)
Add a geometric mean function
Diffstat (limited to 'pkg/man')
-rw-r--r--pkg/man/geomean.Rd31
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
+}
+

Contact - Imprint