aboutsummaryrefslogtreecommitdiff
path: root/docs/geomean.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/geomean.html')
-rw-r--r--docs/geomean.html121
1 files changed, 121 insertions, 0 deletions
diff --git a/docs/geomean.html b/docs/geomean.html
new file mode 100644
index 0000000..3530c32
--- /dev/null
+++ b/docs/geomean.html
@@ -0,0 +1,121 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+<title>geomean. pfm 0.3-8</title>
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<meta name="author" content="
+Johannes Ranke
+">
+
+<link href="css/bootstrap.css" rel="stylesheet">
+<link href="css/bootstrap-responsive.css" rel="stylesheet">
+<link href="css/highlight.css" rel="stylesheet">
+<link href="css/staticdocs.css" rel="stylesheet">
+
+<!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+<![endif]-->
+
+<script type="text/x-mathjax-config">
+ MathJax.Hub.Config({
+ tex2jax: {
+ inlineMath: [ ['$','$'], ["\\(","\\)"] ],
+ processEscapes: true
+ }
+ });
+</script>
+<script type="text/javascript"
+ src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
+</script>
+ </head>
+
+ <body>
+ <div class="navbar">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="brand" href="index.html">pfm 0.3-8</a>
+ <div class="nav">
+ <ul class="nav">
+ <li><a href="index.html">Home</a></li>
+ <li><a href="reference.html">Reference</a></li>
+ </ul>
+ </div>
+ </div>
+ </div>
+</div>
+
+
+ <div class="container">
+ <header>
+
+ </header>
+
+ <h1>Calculate the geometric mean</h1>
+
+<div class="row">
+ <div class="span8">
+ <h2>Usage</h2>
+ <pre><span class="functioncall"><a href='geomean.html'>geomean</a></span><span class="keyword">(</span><span class="symbol">x</span><span class="keyword">,</span> <span class="argument">na.rm</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="number">TRUE</span><span class="keyword">)</span></pre>
+
+ <h2>Arguments</h2>
+ <dl>
+ <dt>x</dt>
+ <dd>Vector of numbers</dd>
+ <dt>na.rm</dt>
+ <dd>Should NA values be omitted?</dd>
+ </dl>
+
+ <div class="Value">
+ <h2>Value</h2>
+
+ <p><dl>
+The geometric mean
+</dl></p>
+
+ </div>
+
+ <div class="Description">
+ <h2>Description</h2>
+
+ <p>Based on some posts in a thread on Stackoverflow
+<a href = 'http://stackoverflow.com/questions/2602583/geometric-mean-is-there-a-built-in'>http://stackoverflow.com/questions/2602583/geometric-mean-is-there-a-built-in</a>
+This function checks for negative values, removes NA values per default and
+returns 0 if at least one element of the vector is 0.</p>
+
+ </div>
+
+ <h2 id="examples">Examples</h2>
+ <pre class="examples"><div class='input'><span class="functioncall"><a href='geomean.html'>geomean</a></span><span class="keyword">(</span><span class="functioncall"><a href='http://www.rdocumentation.org/packages/base/topics/c'>c</a></span><span class="keyword">(</span><span class="number">1</span><span class="keyword">,</span> <span class="number">3</span><span class="keyword">,</span> <span class="number">9</span><span class="keyword">)</span><span class="keyword">)</span></div>
+<div class='output'>[1] 3
+</div>
+<div class='input'><span class="functioncall"><a href='geomean.html'>geomean</a></span><span class="keyword">(</span><span class="functioncall"><a href='http://www.rdocumentation.org/packages/base/topics/c'>c</a></span><span class="keyword">(</span><span class="number">1</span><span class="keyword">,</span> <span class="number">3</span><span class="keyword">,</span> <span class="number">NA</span><span class="keyword">,</span> <span class="number">9</span><span class="keyword">)</span><span class="keyword">)</span></div>
+<div class='output'>[1] 3
+</div>
+<div class='input'><span class="comment">## Not run: geomean(c(1, -3, 9)) # returns an error</span></div></pre>
+ </div>
+ <div class="span4 sidebar">
+ <!-- <ul>
+ <li>geomean</li>
+ </ul>
+ <ul>
+
+ </ul> -->
+
+
+
+ <h2>Author</h2>
+
+Johannes Ranke
+
+
+ </div>
+</div>
+
+ <footer>
+ <p class="pull-right"><a href="#">Back to top</a></p>
+<p>Built by <a href="https://github.com/hadley/staticdocs">staticdocs</a>. Styled with <a href="https://getbootstrap.com/2.0.4/">bootstrap</a>.</p>
+ </footer>
+ </div>
+ </body>
+</html> \ No newline at end of file

Contact - Imprint