diff options
Diffstat (limited to 'docs/reference/geomean.html')
| -rw-r--r-- | docs/reference/geomean.html | 95 |
1 files changed, 95 insertions, 0 deletions
diff --git a/docs/reference/geomean.html b/docs/reference/geomean.html index 20ee17d..0dbc6d1 100644 --- a/docs/reference/geomean.html +++ b/docs/reference/geomean.html @@ -1,4 +1,46 @@ <!DOCTYPE html> +<<<<<<< HEAD +<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Calculate the geometric mean — geomean • pfm</title><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous"><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css"><script src="../bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"><script src="../pkgdown.js"></script><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 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."><!-- 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><!--[if lt IE 9]> +<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script> +<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> +<![endif]--></head><body data-spy="scroll" data-target="#toc"> + + + <div class="container template-reference-topic"> + <header><div class="navbar navbar-default navbar-fixed-top" role="navigation"> + <div class="container"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <span class="navbar-brand"> + <a class="navbar-link" href="../index.html">pfm</a> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.6.1</span> + </span> + </div> + + <div id="navbar" class="navbar-collapse collapse"> + <ul class="nav navbar-nav"><li> + <a href="../reference/index.html">Reference</a> +</li> + </ul><ul class="nav navbar-nav navbar-right"></ul></div><!--/.nav-collapse --> + </div><!--/.container --> +</div><!--/.navbar --> + + + + </header><div class="row"> + <div class="col-md-9 contents"> + <div class="page-header"> + <h1>Calculate the geometric mean</h1> +======= <!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="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 returns NA if NA values are present and na.rm = FALSE @@ -40,6 +82,7 @@ If at least one element of the vector is 0, it returns 0."><!-- mathjax --><scri </li> </ul></div> +>>>>>>> refs/remotes/origin/main </div> </nav><div class="container template-reference-topic"> @@ -58,6 +101,14 @@ This function returns NA if NA values are present and na.rm = FALSE If at least one element of the vector is 0, it returns 0.</p> </div> +<<<<<<< HEAD + <div id="ref-usage"> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">geomean</span><span class="op">(</span><span class="va">x</span>, na.rm <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span></code></pre></div> + </div> + + <div id="arguments"> + <h2>Arguments</h2> +======= <div class="section level2"> <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2> <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">geomean</span><span class="op">(</span><span class="va">x</span>, na.rm <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span></code></pre></div> @@ -65,6 +116,7 @@ If at least one element of the vector is 0, it returns 0.</p> <div class="section level2"> <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2> +>>>>>>> refs/remotes/origin/main <dl><dt>x</dt> <dd><p>Vector of numbers</p></dd> @@ -73,12 +125,26 @@ If at least one element of the vector is 0, it returns 0.</p> <dd><p>Should NA values be omitted?</p></dd> </dl></div> +<<<<<<< HEAD + <div id="value"> + <h2>Value</h2> +======= <div class="section level2"> <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2> +>>>>>>> refs/remotes/origin/main <p>The geometric mean</p> </div> +<<<<<<< HEAD + <div id="author"> + <h2>Author</h2> + <p>Johannes Ranke</p> + </div> + + <div id="ref-examples"> + <h2>Examples</h2> +======= <div class="section level2"> <h2 id="author">Author<a class="anchor" aria-label="anchor" href="#author"></a></h2> <p>Johannes Ranke</p> @@ -86,10 +152,33 @@ If at least one element of the vector is 0, it returns 0.</p> <div class="section level2"> <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2> +>>>>>>> refs/remotes/origin/main <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="fu">geomean</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">1</span>, <span class="fl">3</span>, <span class="fl">9</span><span class="op">)</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] 3</span> <span class="r-in"><span><span class="fu">geomean</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">1</span>, <span class="fl">3</span>, <span class="cn">NA</span>, <span class="fl">9</span><span class="op">)</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] NA</span> +<<<<<<< HEAD +<span class="r-in"><span><span class="fu">geomean</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">1</span>, <span class="op">-</span><span class="fl">3</span>, <span class="fl">9</span><span class="op">)</span><span class="op">)</span> <span class="co"># returns an error</span></span></span> +<span class="r-err co"><span class="r-pr">#></span> <span class="error">Error in geomean(c(1, -3, 9)):</span> Only defined for positive numbers</span> +</code></pre></div> + </div> + </div> + <div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar"> + <nav id="toc" data-toggle="toc" class="sticky-top"><h2 data-toc-skip>Contents</h2> + </nav></div> +</div> + + + <footer><div class="copyright"> + <p></p><p>Developed by Johannes Ranke.</p> +</div> + +<div class="pkgdown"> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> +</div> + + </footer></div> +======= <span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="fu">geomean</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">1</span>, <span class="op">-</span><span class="fl">3</span>, <span class="fl">9</span><span class="op">)</span><span class="op">)</span> <span class="co"># returns an error</span></span></span> </code></pre></div> </div> @@ -106,10 +195,16 @@ If at least one element of the vector is 0, it returns 0.</p> </div> </footer></div> +>>>>>>> refs/remotes/origin/main + + +<<<<<<< HEAD +======= +>>>>>>> refs/remotes/origin/main </body></html> |