Mention pkgdown.jrwb.de/mkin in README

Add very small twa vignette, update pkgdown docs
author: Johannes Ranke <jranke@uni-bremen.de> 2017-03-04 09:58:00 +0100
committer: Johannes Ranke <jranke@uni-bremen.de> 2017-03-04 09:58:00 +0100
commit: 3010c9dcbc7f90f15b55c14919f6688d61d14414 (patch)
tree: 781d9678bd25b451bce0c7b6d47e396be9c6ca1c /docs/reference/twa.html
parent: b847fec686bc1db59079412eb18063d3514ecf75 (diff)
1 files changed, 174 insertions, 0 deletions
diff --git a/docs/reference/twa.html b/docs/reference/twa.html
new file mode 100644
index 00000000..9c2efd10
--- /dev/null
+++ b/docs/reference/twa.html
@@ -0,0 +1,174 @@
+<!-- Generated by pkgdown: do not edit by hand -->
+<!DOCTYPE html>
+<html>
+  <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>
+ — twa • mkin</title>
+
+<!-- jquery -->
+<script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script>
+<!-- Bootstrap -->
+
+<link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
+<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
+
+<!-- Font Awesome icons -->
+<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-T8Gy5hrqNKT+hzMclPo118YTQO6cYprQmhrYwIiQ/3axmI1hQomh7Ud2hPOy8SP1" crossorigin="anonymous">
+
+
+<!-- pkgdown -->
+<link href="../pkgdown.css" rel="stylesheet">
+<script src="../jquery.sticky-kit.min.js"></script>
+<script src="../pkgdown.js"></script>
+
+<!-- mathjax -->
+<script src='https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></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>
+    <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">
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+      </button>
+      <a class="navbar-brand" href="../index.html">mkin</a>
+    </div>
+    <div id="navbar" class="navbar-collapse collapse">
+      <ul class="nav navbar-nav">
+        <li>
+  <a href="../reference/index.html">Functions and data</a>
+</li>
+<li class="dropdown">
+  <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
+    Articles
+     
+    <span class="caret"></span>
+  </a>
+  <ul class="dropdown-menu" role="menu">
+    <li>
+      <a href="../articles/mkin.html">Introduction to mkin</a>
+    </li>
+    <li>
+      <a href="../articles/FOCUS_D.html">Example evaluation of FOCUS Example Dataset D</a>
+    </li>
+    <li>
+      <a href="../articles/FOCUS_L.html">Example evaluation of FOCUS Laboratory Data L1 to L3</a>
+    </li>
+    <li>
+      <a href="../articles/compiled_models.html">Performance benefit by using compiled model definitions in mkin</a>
+    </li>
+  </ul>
+</li>
+<li>
+  <a href="../news/index.html">News</a>
+</li>
+      </ul>
+      
+      <ul class="nav navbar-nav navbar-right">
+        <li>
+  <a href="http://github.com/jranke/mkin">
+    <span class="fa fa-github fa-lg"></span>
+     
+  </a>
+</li>
+      </ul>
+    </div><!--/.nav-collapse -->
+  </div><!--/.container -->
+</div><!--/.navbar -->
+
+      
+      </header>
+
+      <div class="row">
+  <div class="col-md-9 contents">
+    <div class="page-header">
+    <h1>
+</h1>
+    </div>
+
+    
+    <p>This function calculates maximum moving window time weighted average concentrations
+(TWAs) for kinetic models fitted with <code><a href='mkinfit.html'>mkinfit</a></code>. Currently, only
+calculations for the parent are implemented for the SFO, FOMC and DFOP models,
+using the analytical formulas given in the PEC soil section of the FOCUS
+guidance.</p>
+    
+
+    <pre><span class='fu'>twa</span>(<span class='no'>fit</span>, <span class='no'>windows</span>)</pre>
+    
+    <h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a> Arguments</h2>
+    <dl class="dl-horizontal">
+      <dt>fit</dt>
+      <dd>
+    An object of class <code><a href='mkinfit.html'>mkinfit</a></code>.
+  </dd>
+      <dt>windows</dt>
+      <dd>
+    The width of the time windows for which the TWAs should be calculated.
+  </dd>
+    </dl>
+    
+    <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
+
+    <p>A numeric vector, named using the <code>windows</code> argument.</p>
+    
+    <h2 class="hasAnchor" id="references"><a class="anchor" href="#references"></a>References</h2>
+
+    <p>FOCUS (2006) &#8220;Guidance Document on Estimating Persistence and
+  Degradation Kinetics from Environmental Fate Studies on Pesticides in EU
+  Registration&#8221; Report of the FOCUS Work Group on Degradation Kinetics,
+  EC Document Reference Sanco/10058/2005 version 2.0, 434 pp,
+  <a href = 'http://http://esdac.jrc.ec.europa.eu/projects/degradation-kinetics'>http://http://esdac.jrc.ec.europa.eu/projects/degradation-kinetics</a></p>
+    
+
+    <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
+    <pre class="examples"><div class='input'>  <span class='no'>fit</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='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='fu'>twa</span>(<span class='no'>fit</span>, <span class='fu'>c</span>(<span class='fl'>7</span>, <span class='fl'>21</span>))</div><div class='output co'>#&gt; <span class='error'>Error in eval(expr, envir, enclos): konnte Funktion &quot;twa&quot; nicht finden</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="#references">References</a></li>
+      
+      <li><a href="#examples">Examples</a></li>
+    </ul>
+
+    <h2>Author</h2>
+    
+  Johannes Ranke
+
+  </div>
+</div>
+
+      <footer>
+      <div class="copyright">
+  <p>Developed by Johannes Ranke.</p>
+</div>
+
+<div class="pkgdown">
+  <p>Site built with <a href="http://hadley.github.io/pkgdown/">pkgdown</a>.</p>
+</div>
+
+      </footer>
+   </div>
+
+  </body>
+</html>
author	Johannes Ranke <jranke@uni-bremen.de>	2017-03-04 09:58:00 +0100
committer	Johannes Ranke <jranke@uni-bremen.de>	2017-03-04 09:58:00 +0100
commit	3010c9dcbc7f90f15b55c14919f6688d61d14414 (patch)
tree	781d9678bd25b451bce0c7b6d47e396be9c6ca1c /docs/reference/twa.html
parent	b847fec686bc1db59079412eb18063d3514ecf75 (diff)