aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/sawtooth.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/sawtooth.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/sawtooth.html')
-rw-r--r--docs/reference/sawtooth.html21
1 files changed, 12 insertions, 9 deletions
diff --git a/docs/reference/sawtooth.html b/docs/reference/sawtooth.html
index c6756a9..7720afc 100644
--- a/docs/reference/sawtooth.html
+++ b/docs/reference/sawtooth.html
@@ -8,11 +8,13 @@
<title>Create decline time series for multiple applications — sawtooth • 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,14 +34,15 @@
-<meta property="og:title" content="Create decline time series for multiple applications — sawtooth" />
+<meta property="og:title" content="Create decline time series for multiple applications — sawtooth" />
<meta property="og:description" content="If the application pattern is specified in applications,
n and i are disregarded." />
<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>
@@ -83,7 +86,6 @@ n and i are disregarded." />
<a href="../reference/index.html">Reference</a>
</li>
</ul>
-
<ul class="nav navbar-nav navbar-right">
</ul>
@@ -105,15 +107,17 @@ n and i are disregarded." />
</div>
<div class="ref-description">
-
<p>If the application pattern is specified in <code>applications</code>,
<code>n</code> and <code>i</code> are disregarded.</p>
-
</div>
- <pre class="usage"><span class='fu'>sawtooth</span>(<span class='no'>x</span>, <span class='kw'>n</span> <span class='kw'>=</span> <span class='fl'>1</span>, <span class='kw'>i</span> <span class='kw'>=</span> <span class='fl'>365</span>, <span class='kw'>applications</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/data.frame.html'>data.frame</a></span>(<span class='kw'>time</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/seq.html'>seq</a></span>(<span class='fl'>0</span>,
- (<span class='no'>n</span> - <span class='fl'>1</span>) * <span class='no'>i</span>, <span class='kw'>length.out</span> <span class='kw'>=</span> <span class='no'>n</span>), <span class='kw'>amount</span> <span class='kw'>=</span> <span class='fl'>1</span>))</pre>
-
+ <pre class="usage"><span class='fu'>sawtooth</span>(
+ <span class='no'>x</span>,
+ <span class='kw'>n</span> <span class='kw'>=</span> <span class='fl'>1</span>,
+ <span class='kw'>i</span> <span class='kw'>=</span> <span class='fl'>365</span>,
+ <span class='kw'>applications</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/data.frame.html'>data.frame</a></span>(<span class='kw'>time</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/seq.html'>seq</a></span>(<span class='fl'>0</span>, (<span class='no'>n</span> - <span class='fl'>1</span>) * <span class='no'>i</span>, <span class='kw'>length.out</span> <span class='kw'>=</span> <span class='no'>n</span>), <span class='kw'>amount</span> <span class='kw'>=</span> <span class='fl'>1</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>
@@ -136,7 +140,7 @@ is ignored</p></td>
the corresponding amounts applied in the second column.</p></td>
</tr>
</table>
-
+
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
<pre class="examples"><div class='input'><span class='no'>applications</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/data.frame.html'>data.frame</a></span>(<span class='kw'>time</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/seq.html'>seq</a></span>(<span class='fl'>0</span>, <span class='fl'>14</span>, <span class='kw'>by</span> <span class='kw'>=</span> <span class='fl'>7</span>), <span class='kw'>amount</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='fl'>1</span>, <span class='fl'>2</span>, <span class='fl'>3</span>))
@@ -162,7 +166,6 @@ the corresponding amounts applied in the second column.</p></td>
<h2>Contents</h2>
<ul class="nav nav-pills nav-stacked">
<li><a href="#arguments">Arguments</a></li>
-
<li><a href="#examples">Examples</a></li>
</ul>

Contact - Imprint