aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/geomean.html
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2020-04-16 18:02:18 +0200
committerJohannes Ranke <jranke@uni-bremen.de>2020-04-16 18:02:18 +0200
commitd81550d0cccae824cc748de48e7fd50ea8d8033a (patch)
treecb95252ff725b5dcd0237bb8f74fdac4a3e08d15 /docs/reference/geomean.html
parent4bc95b3e4aae22e4052e0a4c905a9227c909e2cd (diff)
Make na.rm = FALSE the default for geomean()
This makes more sense and is in line with mean() from base R. Adapt tests and update docs.
Diffstat (limited to 'docs/reference/geomean.html')
-rw-r--r--docs/reference/geomean.html29
1 files changed, 14 insertions, 15 deletions
diff --git a/docs/reference/geomean.html b/docs/reference/geomean.html
index 469e12f..34befc3 100644
--- a/docs/reference/geomean.html
+++ b/docs/reference/geomean.html
@@ -8,11 +8,13 @@
<title>Calculate the geometric mean — geomean • pfm</title>
+
<!-- jquery -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
<!-- Bootstrap -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha256-916EbMg70RQy9LHiGkXzG8hSg9EdNy97GazNG/aiY1w=" crossorigin="anonymous" />
+
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script>
<!-- Font Awesome icons -->
@@ -32,16 +34,18 @@
-<meta property="og:title" content="Calculate the geometric mean — geomean" />
+<meta property="og:title" content="Calculate the geometric mean — geomean" />
<meta property="og:description" content="Based on some posts in a thread on Stackoverflow
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." />
+This function returns NA if NA values are present and na.rm = FALSE
+(default). If negative values are present, it gives an error message.
+If at least one element of the vector is 0, it returns 0." />
<meta name="twitter:card" content="summary" />
+
<!-- mathjax -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script>
@@ -85,7 +89,6 @@ returns 0 if at least one element of the vector is 0." />
<a href="../reference/index.html">Reference</a>
</li>
</ul>
-
<ul class="nav navbar-nav navbar-right">
</ul>
@@ -107,16 +110,15 @@ returns 0 if at least one element of the vector is 0." />
</div>
<div class="ref-description">
-
<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>
-
+This function returns NA if NA values are present and na.rm = FALSE
+(default). If negative values are present, it gives an error message.
+If at least one element of the vector is 0, it returns 0.</p>
</div>
- <pre class="usage"><span class='fu'>geomean</span>(<span class='no'>x</span>, <span class='kw'>na.rm</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>)</pre>
-
+ <pre class="usage"><span class='fu'>geomean</span>(<span class='no'>x</span>, <span class='kw'>na.rm</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>)</pre>
+
<h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
<table class="ref-arguments">
<colgroup><col class="name" /><col class="desc" /></colgroup>
@@ -129,22 +131,19 @@ returns 0 if at least one element of the vector is 0.</p>
<td><p>Should NA values be omitted?</p></td>
</tr>
</table>
-
+
<h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
<p>The geometric mean</p>
-
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
- <pre class="examples"><div class='input'><span class='fu'>geomean</span>(<span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='fl'>1</span>, <span class='fl'>3</span>, <span class='fl'>9</span>))</div><div class='output co'>#&gt; [1] 3</div><div class='input'><span class='fu'>geomean</span>(<span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='fl'>1</span>, <span class='fl'>3</span>, <span class='fl'>NA</span>, <span class='fl'>9</span>))</div><div class='output co'>#&gt; [1] 3</div><div class='input'><span class='kw'>if</span> (<span class='fl'>FALSE</span>) <span class='fu'>geomean</span>(<span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='fl'>1</span>, -<span class='fl'>3</span>, <span class='fl'>9</span>)) <span class='co'># returns an error</span></div></pre>
+ <pre class="examples"><div class='input'><span class='fu'>geomean</span>(<span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='fl'>1</span>, <span class='fl'>3</span>, <span class='fl'>9</span>))</div><div class='output co'>#&gt; [1] 3</div><div class='input'><span class='fu'>geomean</span>(<span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='fl'>1</span>, <span class='fl'>3</span>, <span class='fl'>NA</span>, <span class='fl'>9</span>))</div><div class='output co'>#&gt; [1] NA</div><div class='input'><span class='kw'>if</span> (<span class='fl'>FALSE</span>) <span class='fu'>geomean</span>(<span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='fl'>1</span>, -<span class='fl'>3</span>, <span class='fl'>9</span>)) <span class='co'># returns an error</span></div></pre>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
<h2>Contents</h2>
<ul class="nav nav-pills nav-stacked">
<li><a href="#arguments">Arguments</a></li>
-
<li><a href="#value">Value</a></li>
-
<li><a href="#examples">Examples</a></li>
</ul>

Contact - Imprint