added geometric mean

Author: eduardszoecs

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: esmisc
 Type: Package
 Title: Misc Functions of Eduard Szöcs
-Version: 0.0.3.9000
+Version: 0.0.3.9001
 Date: 2017-01-10
 Authors@R: c(person("Eduard", "Szöcs", role = c("aut", "cre"),
     email = "[email protected]"))
@@ -23,4 +23,4 @@ Imports:
     readr
 Suggests:
     testthat
-RoxygenNote: 5.0.1
+RoxygenNote: 6.0.0

NAMESPACE

@@ -1,5 +1,6 @@
 # Generated by roxygen2: do not edit by hand
 
+export(geomean)
 export(read_regnie)
 export(theme_edi)
 import(ggplot2)

NEWS

@@ -4,6 +4,8 @@ esmisc 0.0.4
 
 NEW FEATURES
 
+* added function for geometric mean
+
 MINOR IMPROVEMENTS
 
 BUG FIXES

R/geomean.R

@@ -0,0 +1,21 @@
+#' Geometric mean
+#' 
+#' Function for the geometric mean. 
+#' 
+#' @details The geometric mean is comuted as
+#' \deqn{x = e^{(\sum \log x) / n}}
+#' 
+#' @param x a numeric vector.
+#' @param na.rm a logical value indicating whether NA values should be 
+#' stripped before the computation proceeds.
+#' 
+#' @return  numeric vector of length one with the geometric mean.
+#' @references \url{http://stackoverflow.com/questions/2602583/geometric-mean-is-there-a-built-in}
+#' @export
+#' @examples 
+#' x <- c(1, 10, 100)
+#' mean(x)
+#' geomean(x)
+geomean = function(x, na.rm = TRUE){
+  exp(sum(log(x[x > 0]), na.rm = na.rm) / length(x))
+}

README.Rmd

@@ -55,4 +55,13 @@ p <- ggplot(mtcars) +
   facet_wrap(~am) + 
   theme_edi()
 p
-````
+```
+
+### other functions
+
+#### Geometric mean
+```{r}
+mean(c(1, 10, 100))
+geomean(c(1, 10, 100))
+```
+

README.md

@@ -55,3 +55,15 @@ Examples
     p
 
 ![](README_files/figure-markdown_strict/ggplot_themes-1.png)
+
+### other functions
+
+#### Geometric mean
+
+    mean(c(1, 10, 100))
+
+    ## [1] 37
+
+    geomean(c(1, 10, 100))
+
+    ## [1] 10

man/geomean.Rd

@@ -0,0 +1,11 @@
+context("geomean")
+
+x <- c(1, 10, 100)
+gx <- geomean(x)
+
+test_that('geomean works', {
+  expect_is(gx, "numeric")
+  expect_equal(length(gx), 1)
+  expect_equal(gx, 10)
+})
+