1 files changed, 170 insertions, 0 deletions
diff --git a/docs/reference/endpoint.html b/docs/reference/endpoint.html
new file mode 100644
index 0000000..57a7652
--- /dev/null
+++ b/docs/reference/endpoint.html
@@ -0,0 +1,170 @@
+<!-- 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>Retrieve endpoint information from the chyaml field of a chent object — endpoint • pfm</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">pfm</a>
+    </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>Retrieve endpoint information from the chyaml field of a chent object</h1>
+    </div>
+
+    
+    <p>R6 class objects of class chent represent chemical entities
+and can hold a list of information loaded from a chemical yaml file in their
+chyaml field. Such information is extracted and optionally aggregated by
+this function.</p>
+    
+
+    <pre><span class='fu'>endpoint</span>(<span class='no'>chent</span>, <span class='kw'>medium</span> <span class='kw'>=</span> <span class='st'>"soil"</span>, <span class='kw'>type</span> <span class='kw'>=</span> <span class='fu'>c</span>(<span class='st'>"degradation"</span>, <span class='st'>"sorption"</span>),
+  <span class='kw'>lab_field</span> <span class='kw'>=</span> <span class='fu'>c</span>(<span class='fl'>NA</span>, <span class='st'>"laboratory"</span>, <span class='st'>"field"</span>), <span class='kw'>redox</span> <span class='kw'>=</span> <span class='fu'>c</span>(<span class='fl'>NA</span>, <span class='st'>"aerobic"</span>,
+  <span class='st'>"anaerobic"</span>), <span class='kw'>value</span> <span class='kw'>=</span> <span class='fu'>c</span>(<span class='st'>"DT50ref"</span>, <span class='st'>"Kfoc"</span>, <span class='st'>"N"</span>), <span class='kw'>aggregator</span> <span class='kw'>=</span> <span class='no'>geomean</span>,
+  <span class='kw'>raw</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>, <span class='kw'>signif</span> <span class='kw'>=</span> <span class='fl'>3</span>)
+
+<span class='fu'>soil_DT50</span>(<span class='no'>chent</span>, <span class='kw'>aggregator</span> <span class='kw'>=</span> <span class='no'>geomean</span>, <span class='kw'>signif</span> <span class='kw'>=</span> <span class='fl'>3</span>,
+  <span class='kw'>lab_field</span> <span class='kw'>=</span> <span class='st'>"laboratory"</span>, <span class='kw'>value</span> <span class='kw'>=</span> <span class='st'>"DT50ref"</span>, <span class='kw'>redox</span> <span class='kw'>=</span> <span class='st'>"aerobic"</span>,
+  <span class='kw'>raw</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>)
+
+<span class='fu'>soil_Kfoc</span>(<span class='no'>chent</span>, <span class='kw'>aggregator</span> <span class='kw'>=</span> <span class='no'>geomean</span>, <span class='kw'>signif</span> <span class='kw'>=</span> <span class='fl'>3</span>, <span class='kw'>value</span> <span class='kw'>=</span> <span class='st'>"Kfoc"</span>,
+  <span class='kw'>raw</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>)
+
+<span class='fu'>soil_N</span>(<span class='no'>chent</span>, <span class='kw'>aggregator</span> <span class='kw'>=</span> <span class='no'>mean</span>, <span class='kw'>signif</span> <span class='kw'>=</span> <span class='fl'>3</span>, <span class='kw'>raw</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>)
+
+<span class='fu'>soil_sorption</span>(<span class='no'>chent</span>, <span class='kw'>values</span> <span class='kw'>=</span> <span class='fu'>c</span>(<span class='st'>"Kfoc"</span>, <span class='st'>"N"</span>), <span class='kw'>aggregators</span> <span class='kw'>=</span> <span class='fu'>c</span>(<span class='kw'>Kfoc</span> <span class='kw'>=</span>
+  <span class='no'>geomean</span>, <span class='kw'>Koc</span> <span class='kw'>=</span> <span class='no'>geomean</span>, <span class='kw'>N</span> <span class='kw'>=</span> <span class='no'>mean</span>), <span class='kw'>signif</span> <span class='kw'>=</span> <span class='fu'>c</span>(<span class='kw'>Kfoc</span> <span class='kw'>=</span> <span class='fl'>3</span>, <span class='kw'>N</span> <span class='kw'>=</span> <span class='fl'>3</span>),
+  <span class='kw'>raw</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>)</pre>
+    
+    <h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a> Arguments</h2>
+    <dl class="dl-horizontal">
+      <dt>chent</dt>
+      <dd>The chent object to get the information from</dd>
+      <dt>medium</dt>
+      <dd>The medium for which information is sought</dd>
+      <dt>type</dt>
+      <dd>The information type</dd>
+      <dt>lab_field</dt>
+      <dd>If not NA, do we want laboratory or field endpoints</dd>
+      <dt>redox</dt>
+      <dd>If not NA, are we looking for aerobic or anaerobic data</dd>
+      <dt>value</dt>
+      <dd>The name of the value we want. The list given in the 
+usage section is not exclusive</dd>
+      <dt>aggregator</dt>
+      <dd>The aggregator function. Can be mean, 
+<code><a href='geomean.html'>geomean</a></code>, or identity, for example.</dd>
+      <dt>raw</dt>
+      <dd>Should the number(s) be returned as stored in the chent
+object (could be a character value) to retain original information
+about precision?</dd>
+      <dt>signif</dt>
+      <dd>How many significant digits do we want</dd>
+      <dt>values</dt>
+      <dd>The values to be returned</dd>
+      <dt>aggregators</dt>
+      <dd>A named vector of aggregator functions to be used</dd>
+    </dl>
+    
+    <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
+
+    <p>The result from applying the aggregator function to
+  the values converted to a numeric vector, rounded to the
+  given number of significant digits, or, if raw = TRUE,
+  the values as a character value, retaining any implicit
+  information on precision that may be present.</p>
+    
+    <h2 class="hasAnchor" id="details"><a class="anchor" href="#details"></a>Details</h2>
+
+    <p>The functions <code>soil_*</code> are functions to extract soil specific endpoints.
+For the Freundlich exponent, the capital letter <code>N</code> is used in order to
+facilitate dealing with such data in R. In pesticide fate modelling, this
+exponent is often called 1/n.</p>
+    
+
+  </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="#details">Details</a></li>
+          </ul>
+
+  </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>