aboutsummaryrefslogtreecommitdiff
path: root/man/geometric_mean.Rd
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2014-06-26 10:26:49 +0200
committerJohannes Ranke <jranke@uni-bremen.de>2014-06-26 10:26:49 +0200
commite8cf8558b7d071f800a65c3688f19d5ae400c33f (patch)
treecfb3055c0b4c759794664a3b25a8a08beb3ac8ef /man/geometric_mean.Rd
parent6fd8b2a1ef16265f12d54bb182393bdeaada2db4 (diff)
Add function for geometric mean
Diffstat (limited to 'man/geometric_mean.Rd')
-rw-r--r--man/geometric_mean.Rd23
1 files changed, 23 insertions, 0 deletions
diff --git a/man/geometric_mean.Rd b/man/geometric_mean.Rd
new file mode 100644
index 00000000..faad666f
--- /dev/null
+++ b/man/geometric_mean.Rd
@@ -0,0 +1,23 @@
+\name{geometric_mean}
+\Rdversion{1.1}
+\alias{geometric_mean}
+\title{ Calculate the geometric mean }
+\description{
+ Function calculating the geometric mean of numeric vectors
+}
+\usage{
+ geometric_mean(x, na.rm = FALSE)
+}
+\arguments{
+ \item{x}{ A numeric vector }
+ \item{na.rm}{ Should NA values be ignored }
+}
+\value{
+ The geometric mean.
+}
+\examples{
+ geometric_mean(c(1,3, 9))
+ geometric_mean(c(1,3, NA))
+ geometric_mean(c(1,3, NA), na.rm = TRUE)
+}
+\keyword{ manip }

Contact - Imprint