diff options
| author | Johannes Ranke <jranke@uni-bremen.de> | 2019-09-18 18:18:40 +0200 |
|---|---|---|
| committer | Johannes Ranke <jranke@uni-bremen.de> | 2019-09-18 18:18:40 +0200 |
| commit | 803fe13e505960fddccdbd4dcb524715f5eb068d (patch) | |
| tree | be5a3b2ca52e20b3bfae758299febf15c889d621 /docs/reference/one_box.html | |
| parent | 8deaa29a659630a40e8b11df1fa3ebbbd9ca9e68 (diff) | |
Add url: tag to _pkgdown.yml, typo, update docs
Diffstat (limited to 'docs/reference/one_box.html')
| -rw-r--r-- | docs/reference/one_box.html | 44 |
1 files changed, 23 insertions, 21 deletions
diff --git a/docs/reference/one_box.html b/docs/reference/one_box.html index e7379e2..ebfb872 100644 --- a/docs/reference/one_box.html +++ b/docs/reference/one_box.html @@ -16,13 +16,15 @@ <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 --> -<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css" integrity="sha256-eZrrJcwDc/3uDhsdt61sL2oOBY362qM3lon1gyExkL0=" crossorigin="anonymous" /> +<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.7.1/css/all.min.css" integrity="sha256-nAmazAk6vS34Xqo0BSrTb+abbtFlgsFK7NKSi6o7Y78=" crossorigin="anonymous" /> +<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.7.1/css/v4-shims.min.css" integrity="sha256-6qHlizsOWFskGlwVOKuns+D1nB6ssZrHQrNj1wGplHc=" crossorigin="anonymous" /> <!-- clipboard.js --> <script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.4/clipboard.min.js" integrity="sha256-FiZwavyI2V6+EXO1U+xzLG3IKldpiTFf3153ea9zikQ=" crossorigin="anonymous"></script> -<!-- sticky kit --> -<script src="https://cdnjs.cloudflare.com/ajax/libs/sticky-kit/1.1.3/sticky-kit.min.js" integrity="sha256-c4Rlo1ZozqTPE2RLuvbusY3+SU1pQaJC0TjuhygMipw=" crossorigin="anonymous"></script> +<!-- headroom.js --> +<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.9.4/headroom.min.js" integrity="sha256-DJFC1kqIhelURkuza0AvYal5RxMtpzLjFhsnVIeuk+U=" crossorigin="anonymous"></script> +<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.9.4/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script> <!-- pkgdown --> <link href="../pkgdown.css" rel="stylesheet"> @@ -47,6 +49,7 @@ <![endif]--> + </head> <body> @@ -71,7 +74,7 @@ <ul class="nav navbar-nav"> <li> <a href="../index.html"> - <span class="fa fa-home fa-lg"></span> + <span class="fas fa fas fa-home fa-lg"></span> </a> </li> @@ -81,12 +84,7 @@ </ul> <ul class="nav navbar-nav navbar-right"> - <li> - <a href="https://github.com/jranke/pfm"> - <span class="fa fa-github fa-lg"></span> - - </a> -</li> + </ul> </div><!--/.nav-collapse --> @@ -94,13 +92,14 @@ </div><!--/.navbar --> + </header> <div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Create a time series of decline data</h1> - <small class="dont-index">Source: <a href='https://github.com/jranke/pfm/blob/master/R/twa.R'><code>R/twa.R</code></a></small> + <div class="hidden name"><code>one_box.Rd</code></div> </div> @@ -130,7 +129,7 @@ <th>x</th> <td><p>When numeric, this is the half-life to be used for an exponential decline. When a character string specifying a parent decline model is given -e.g. <code>FOMC</code>, <code>parms</code> must contain the corresponding paramters. +e.g. <code>FOMC</code>, <code>parms</code> must contain the corresponding parameters. If x is an <code>mkinfit</code> object, the decline is calculated from this object.</p></td> </tr> @@ -162,22 +161,21 @@ all observed variables.</p></td> <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2> - <p>An object of class <code>one_box</code>, inheriting from <code><a href='https://www.rdocumentation.org/packages/stats/topics/ts'>ts</a></code>.</p> + <p>An object of class <code>one_box</code>, inheriting from <code><a href='https://rdrr.io/r/stats/ts.html'>ts</a></code>.</p> <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2> <pre class="examples"><div class='input'><span class='co'># Only use a half-life</span> <span class='no'>pred_0</span> <span class='kw'><-</span> <span class='fu'>one_box</span>(<span class='fl'>10</span>) -<span class='fu'><a href='https://www.rdocumentation.org/packages/graphics/topics/plot'>plot</a></span>(<span class='no'>pred_0</span>)</div><div class='img'><img src='one_box-1.png' alt='' width='700' height='433' /></div><div class='input'> +<span class='fu'><a href='https://rdrr.io/r/graphics/plot.html'>plot</a></span>(<span class='no'>pred_0</span>)</div><div class='img'><img src='one_box-1.png' alt='' width='700' height='433' /></div><div class='input'> <span class='co'># Use a fitted mkinfit model</span> -<span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/library'>require</a></span>(<span class='no'>mkin</span>) -<span class='no'>fit</span> <span class='kw'><-</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/mkin/topics/mkinfit'>mkinfit</a></span>(<span class='st'>"FOMC"</span>, <span class='no'>FOCUS_2006_C</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>) +<span class='fu'><a href='https://rdrr.io/r/base/library.html'>require</a></span>(<span class='no'>mkin</span>) +<span class='no'>fit</span> <span class='kw'><-</span> <span class='fu'><a href='https://pkgdown.jrwb.de/mkin/reference/mkinfit.html'>mkinfit</a></span>(<span class='st'>"FOMC"</span>, <span class='no'>FOCUS_2006_C</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>) <span class='no'>pred_1</span> <span class='kw'><-</span> <span class='fu'>one_box</span>(<span class='no'>fit</span>) -<span class='fu'><a href='https://www.rdocumentation.org/packages/graphics/topics/plot'>plot</a></span>(<span class='no'>pred_1</span>)</div><div class='img'><img src='one_box-2.png' alt='' width='700' height='433' /></div><div class='input'> +<span class='fu'><a href='https://rdrr.io/r/graphics/plot.html'>plot</a></span>(<span class='no'>pred_1</span>)</div><div class='img'><img src='one_box-2.png' alt='' width='700' height='433' /></div><div class='input'> <span class='co'># Use a model with more than one observed variable</span> -<span class='no'>m_2</span> <span class='kw'><-</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/mkin/topics/mkinmod'>mkinmod</a></span>(<span class='kw'>parent</span> <span class='kw'>=</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/mkin/topics/mkinsub'>mkinsub</a></span>(<span class='st'>"SFO"</span>, <span class='st'>"m1"</span>), <span class='kw'>m1</span> <span class='kw'>=</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/mkin/topics/mkinsub'>mkinsub</a></span>(<span class='st'>"SFO"</span>))</div><div class='output co'>#> <span class='message'>Successfully compiled differential equation model from auto-generated C code.</span></div><div class='input'><span class='no'>fit_2</span> <span class='kw'><-</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/mkin/topics/mkinfit'>mkinfit</a></span>(<span class='no'>m_2</span>, <span class='no'>FOCUS_2006_D</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>) -<span class='no'>pred_2</span> <span class='kw'><-</span> <span class='fu'>one_box</span>(<span class='no'>fit_2</span>, <span class='kw'>ini</span> <span class='kw'>=</span> <span class='st'>"model"</span>) -<span class='fu'><a href='https://www.rdocumentation.org/packages/graphics/topics/plot'>plot</a></span>(<span class='no'>pred_2</span>)</div><div class='img'><img src='one_box-3.png' alt='' width='700' height='433' /></div></pre> +<span class='no'>m_2</span> <span class='kw'><-</span> <span class='fu'><a href='https://pkgdown.jrwb.de/mkin/reference/mkinmod.html'>mkinmod</a></span>(<span class='kw'>parent</span> <span class='kw'>=</span> <span class='fu'><a href='https://pkgdown.jrwb.de/mkin/reference/mkinsub.html'>mkinsub</a></span>(<span class='st'>"SFO"</span>, <span class='st'>"m1"</span>), <span class='kw'>m1</span> <span class='kw'>=</span> <span class='fu'><a href='https://pkgdown.jrwb.de/mkin/reference/mkinsub.html'>mkinsub</a></span>(<span class='st'>"SFO"</span>))</div><div class='output co'>#> <span class='message'>Successfully compiled differential equation model from auto-generated C code.</span></div><div class='input'><span class='no'>fit_2</span> <span class='kw'><-</span> <span class='fu'><a href='https://pkgdown.jrwb.de/mkin/reference/mkinfit.html'>mkinfit</a></span>(<span class='no'>m_2</span>, <span class='no'>FOCUS_2006_D</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>)</div><div class='output co'>#> <span class='warning'>Warning: Observations with value of zero were removed from the data</span></div><div class='input'><span class='no'>pred_2</span> <span class='kw'><-</span> <span class='fu'>one_box</span>(<span class='no'>fit_2</span>, <span class='kw'>ini</span> <span class='kw'>=</span> <span class='st'>"model"</span>) +<span class='fu'><a href='https://rdrr.io/r/graphics/plot.html'>plot</a></span>(<span class='no'>pred_2</span>)</div><div class='img'><img src='one_box-3.png' alt='' width='700' height='433' /></div></pre> </div> <div class="col-md-3 hidden-xs hidden-sm" id="sidebar"> <h2>Contents</h2> @@ -192,19 +190,23 @@ all observed variables.</p></td> </div> </div> + <footer> <div class="copyright"> <p>Developed by Johannes Ranke.</p> </div> <div class="pkgdown"> - <p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.3.0.</p> + <p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.4.1.</p> </div> + </footer> </div> + </body> </html> + |