diff options
| author | Johannes Ranke <jranke@uni-bremen.de> | 2023-11-12 21:40:01 +0100 |
|---|---|---|
| committer | Johannes Ranke <jranke@uni-bremen.de> | 2023-11-12 21:40:01 +0100 |
| commit | d66bd4aa0bf9c4d9b8793a4e308c9e80691b440f (patch) | |
| tree | 6bd9d55442019ef452dd21e7714889998668f6d5 /docs/reference/twa.html | |
| parent | 97d0465a296ef1f5ae4502f9374ae339c0a8148e (diff) | |
Enable links to source, upgrade to bootstrap 5
Diffstat (limited to 'docs/reference/twa.html')
| -rw-r--r-- | docs/reference/twa.html | 235 |
1 files changed, 82 insertions, 153 deletions
diff --git a/docs/reference/twa.html b/docs/reference/twa.html index 2c21c67..fbcbe9a 100644 --- a/docs/reference/twa.html +++ b/docs/reference/twa.html @@ -1,187 +1,116 @@ -<!-- Generated by pkgdown: do not edit by hand --> <!DOCTYPE html> -<html lang="en"> - <head> - <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 a time weighted average concentration — twa • 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 --> -<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> - -<!-- 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"> -<script src="../pkgdown.js"></script> - - - -<meta property="og:title" content="Calculate a time weighted average concentration — twa" /> - -<meta property="og:description" content="The moving average is built only using the values in the past, so +<!-- 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="The moving average is built only using the values in the past, so the earliest possible time for the maximum in the time series returned -is after one window has passed." /> -<meta name="twitter:card" content="summary" /> +is after one window has passed."><title>Calculate a time weighted average concentration — twa • pfm</title><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.2.2/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.2.2/bootstrap.bundle.min.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"><!-- bootstrap-toc --><script src="https://cdn.jsdelivr.net/gh/afeld/bootstrap-toc@v1.0.1/dist/bootstrap-toc.min.js" integrity="sha256-4veVQbu7//Lk5TSmc7YV48MxtMy98e26cf5MrgZYnwo=" 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><!-- 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><!-- search --><script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.js" integrity="sha512-zv6Ywkjyktsohkbp9bb45V6tEMoWhzFzXis+LrMehmJZZSys19Yxf1dopHx7WzIKxr5tK2dVcYmaCk2uqdjF4A==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js" integrity="sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js" integrity="sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww==" crossorigin="anonymous"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Calculate a time weighted average concentration — twa"><meta property="og:description" content="The moving average is built only using the values in the past, so +the earliest possible time for the maximum in the time series returned +is after one window has passed."><!-- 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> + <a href="#main" class="visually-hidden-focusable">Skip to contents</a> + + <nav class="navbar fixed-top navbar-light navbar-expand-lg bg-light"><div class="container"> + + <a class="navbar-brand me-2" href="../index.html">pfm</a> + <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.0</small> -<!-- 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> + + <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation"> + <span class="navbar-toggler-icon"></span> + </button> -<!--[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> - <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="Released version">0.5.7</span> - </span> - </div> + <div id="navbar" class="collapse navbar-collapse ms-3"> + <ul class="navbar-nav me-auto"><li class="active nav-item"> + <a class="nav-link" href="../reference/index.html">Reference</a> +</li> + </ul><form class="form-inline my-2 my-lg-0" role="search"> + <input type="search" class="form-control me-sm-2" aria-label="Toggle navigation" name="search-input" data-search-index="../search.json" id="search-input" placeholder="Search for" autocomplete="off"></form> - <div id="navbar" class="navbar-collapse collapse"> - <ul class="nav navbar-nav"> - <li> - <a href="../index.html"> - <span class="fas fa fas fa-home fa-lg"></span> + <ul class="navbar-nav"><li class="nav-item"> + <a class="external-link nav-link" href="https://github.com/jranke/pfm/" aria-label="github"> + <span class="fab fa fab fa-github fa-lg"></span> </a> </li> -<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> + </ul></div> -<div class="row"> - <div class="col-md-9 contents"> - <div class="page-header"> - <h1>Calculate a time weighted average concentration</h1> - <div class="hidden name"><code>twa.Rd</code></div> + </div> +</nav><div class="container template-reference-topic"> +<div class="row"> + <main id="main" class="col-md-9"><div class="page-header"> + <img src="" class="logo" alt=""><h1>Calculate a time weighted average concentration</h1> + <small class="dont-index">Source: <a href="https://github.com/jranke/pfm/blob/HEAD/R/twa.R" class="external-link"><code>R/twa.R</code></a></small> + <div class="d-none name"><code>twa.Rd</code></div> </div> - <div class="ref-description"> - + <div class="ref-description section level2"> <p>The moving average is built only using the values in the past, so the earliest possible time for the maximum in the time series returned is after one window has passed.</p> - </div> - <pre class="usage"><span class='fu'>twa</span>(<span class='no'>x</span>, <span class='kw'>window</span> <span class='kw'>=</span> <span class='fl'>21</span>) + <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">twa</span><span class="op">(</span><span class="va">x</span>, window <span class="op">=</span> <span class="fl">21</span><span class="op">)</span></span> +<span></span> +<span><span class="co"># S3 method for one_box</span></span> +<span><span class="fu">twa</span><span class="op">(</span><span class="va">x</span>, window <span class="op">=</span> <span class="fl">21</span><span class="op">)</span></span></code></pre></div> + </div> -<span class='co'># S3 method for one_box</span> -<span class='fu'>twa</span>(<span class='no'>x</span>, <span class='kw'>window</span> <span class='kw'>=</span> <span class='fl'>21</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> - <tr> - <th>x</th> - <td><p>An object of type <code><a href='one_box.html'>one_box</a></code></p></td> - </tr> - <tr> - <th>window</th> - <td><p>The size of the moving window</p></td> - </tr> - </table> - - <h2 class="hasAnchor" id="see-also"><a class="anchor" href="#see-also"></a>See also</h2> + <div class="section level2"> + <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2> + <dl><dt>x</dt> +<dd><p>An object of type <code><a href="one_box.html">one_box</a></code></p></dd> - <div class='dont-index'><p><code><a href='max_twa.html'>max_twa</a></code></p></div> - - <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2> - <pre class="examples"><div class='input'><span class='no'>pred</span> <span class='kw'><-</span> <span class='fu'><a href='sawtooth.html'>sawtooth</a></span>(<span class='fu'><a href='one_box.html'>one_box</a></span>(<span class='fl'>10</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/c.html'>c</a></span>(<span class='fl'>0</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'>1</span>))) -<span class='fu'><a href='max_twa.html'>max_twa</a></span>(<span class='no'>pred</span>)</div><div class='output co'>#> $max -#> parent -#> 0.9537545 -#> -#> $window_start -#> parent -#> 0 -#> -#> $window_end -#> parent -#> 21 -#> </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="#see-also">See also</a></li> - - <li><a href="#examples">Examples</a></li> - </ul> +<dt>window</dt> +<dd><p>The size of the moving window</p></dd> - </div> -</div> +</dl></div> + <div class="section level2"> + <h2 id="see-also">See also<a class="anchor" aria-label="anchor" href="#see-also"></a></h2> + <div class="dont-index"><p><code><a href="max_twa.html">max_twa</a></code></p></div> + </div> + + <div class="section level2"> + <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="va">pred</span> <span class="op"><-</span> <span class="fu"><a href="sawtooth.html">sawtooth</a></span><span class="op">(</span><span class="fu"><a href="one_box.html">one_box</a></span><span class="op">(</span><span class="fl">10</span><span class="op">)</span>,</span></span> +<span class="r-in"><span> applications <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame</a></span><span class="op">(</span>time <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">0</span>, <span class="fl">7</span><span class="op">)</span>, amount <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">1</span><span class="op">)</span><span class="op">)</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu"><a href="max_twa.html">max_twa</a></span><span class="op">(</span><span class="va">pred</span><span class="op">)</span></span></span> +<span class="r-out co"><span class="r-pr">#></span> $max</span> +<span class="r-out co"><span class="r-pr">#></span> parent </span> +<span class="r-out co"><span class="r-pr">#></span> 0.9537545 </span> +<span class="r-out co"><span class="r-pr">#></span> </span> +<span class="r-out co"><span class="r-pr">#></span> $window_start</span> +<span class="r-out co"><span class="r-pr">#></span> parent </span> +<span class="r-out co"><span class="r-pr">#></span> 0 </span> +<span class="r-out co"><span class="r-pr">#></span> </span> +<span class="r-out co"><span class="r-pr">#></span> $window_end</span> +<span class="r-out co"><span class="r-pr">#></span> parent </span> +<span class="r-out co"><span class="r-pr">#></span> 21 </span> +<span class="r-out co"><span class="r-pr">#></span> </span> +</code></pre></div> + </div> + </main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2> + </nav></aside></div> - <footer> - <div class="copyright"> - <p>Developed by Johannes Ranke.</p> + <footer><div class="pkgdown-footer-left"> + <p></p><p>Developed by Johannes Ranke.</p> </div> -<div class="pkgdown"> - <p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.4.1.</p> +<div class="pkgdown-footer-right"> + <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> + </footer></div> + - </body> -</html> - + </body></html> |