aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/endpoint.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/reference/endpoint.html')
-rw-r--r--docs/reference/endpoint.html295
1 files changed, 112 insertions, 183 deletions
diff --git a/docs/reference/endpoint.html b/docs/reference/endpoint.html
index 39071ee..8ca3467 100644
--- a/docs/reference/endpoint.html
+++ b/docs/reference/endpoint.html
@@ -1,67 +1,15 @@
-<!-- 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>Retrieve endpoint information from the chyaml field of a chent object — endpoint • 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="Retrieve endpoint information from the chyaml field of a chent object — endpoint" />
-<meta property="og:description" content="R6 class objects of class chent represent chemical entities
+<!-- 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.0"><title>Retrieve endpoint information from the chyaml field of a chent object — endpoint • pfm</title><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous"><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css"><script src="../bootstrap-toc.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"><!-- 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><!-- 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><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"><script src="../pkgdown.js"></script><meta property="og:title" content="Retrieve endpoint information from the chyaml field of a chent object — endpoint"><meta property="og:description" content="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." />
-<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>
-
-<!--[if lt IE 9]>
+this function."><!-- 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>
+<![endif]--></head><body data-spy="scroll" data-target="#toc">
+
- <body>
<div class="container template-reference-topic">
- <header>
- <div class="navbar navbar-default navbar-fixed-top" role="navigation">
+ <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">
@@ -72,35 +20,21 @@ this function." />
</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 class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.6.1</span>
</span>
</div>
<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>
-
- </a>
-</li>
-<li>
+ <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 -->
+ </ul><ul class="nav navbar-nav navbar-right"></ul></div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
- </header>
-
-<div class="row">
+ </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>
@@ -115,136 +49,131 @@ chyaml field. Such information is extracted and optionally aggregated by
this function.</p>
</div>
- <pre class="usage"><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'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='st'>"degradation"</span>, <span class='st'>"sorption"</span>),
- <span class='kw'>lab_field</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></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'><a href='https://rdrr.io/r/base/c.html'>c</a></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'><a href='https://rdrr.io/r/base/c.html'>c</a></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'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='st'>"Kfoc"</span>, <span class='st'>"N"</span>),
- <span class='kw'>aggregators</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></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'><a href='https://rdrr.io/r/base/c.html'>c</a></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>
- <table class="ref-arguments">
- <colgroup><col class="name" /><col class="desc" /></colgroup>
- <tr>
- <th>chent</th>
- <td><p>The chent object to get the information from</p></td>
- </tr>
- <tr>
- <th>medium</th>
- <td><p>The medium for which information is sought</p></td>
- </tr>
- <tr>
- <th>type</th>
- <td><p>The information type</p></td>
- </tr>
- <tr>
- <th>lab_field</th>
- <td><p>If not NA, do we want laboratory or field endpoints</p></td>
- </tr>
- <tr>
- <th>redox</th>
- <td><p>If not NA, are we looking for aerobic or anaerobic data</p></td>
- </tr>
- <tr>
- <th>value</th>
- <td><p>The name of the value we want. The list given in the
-usage section is not exclusive</p></td>
- </tr>
- <tr>
- <th>aggregator</th>
- <td><p>The aggregator function. Can be mean,
-<code><a href='geomean.html'>geomean</a></code>, or identity, for example.</p></td>
- </tr>
- <tr>
- <th>raw</th>
- <td><p>Should the number(s) be returned as stored in the chent
+ <div id="ref-usage">
+ <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">endpoint</span><span class="op">(</span></span>
+<span> <span class="va">chent</span>,</span>
+<span> medium <span class="op">=</span> <span class="st">"soil"</span>,</span>
+<span> type <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="st">"degradation"</span>, <span class="st">"sorption"</span><span class="op">)</span>,</span>
+<span> lab_field <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="cn">NA</span>, <span class="st">"laboratory"</span>, <span class="st">"field"</span><span class="op">)</span>,</span>
+<span> redox <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="cn">NA</span>, <span class="st">"aerobic"</span>, <span class="st">"anaerobic"</span><span class="op">)</span>,</span>
+<span> value <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="st">"DT50ref"</span>, <span class="st">"Kfoc"</span>, <span class="st">"N"</span><span class="op">)</span>,</span>
+<span> aggregator <span class="op">=</span> <span class="va">geomean</span>,</span>
+<span> raw <span class="op">=</span> <span class="cn">FALSE</span>,</span>
+<span> signif <span class="op">=</span> <span class="fl">3</span></span>
+<span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">soil_DT50</span><span class="op">(</span></span>
+<span> <span class="va">chent</span>,</span>
+<span> aggregator <span class="op">=</span> <span class="va">geomean</span>,</span>
+<span> signif <span class="op">=</span> <span class="fl">3</span>,</span>
+<span> lab_field <span class="op">=</span> <span class="st">"laboratory"</span>,</span>
+<span> value <span class="op">=</span> <span class="st">"DT50ref"</span>,</span>
+<span> redox <span class="op">=</span> <span class="st">"aerobic"</span>,</span>
+<span> raw <span class="op">=</span> <span class="cn">FALSE</span></span>
+<span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">soil_Kfoc</span><span class="op">(</span><span class="va">chent</span>, aggregator <span class="op">=</span> <span class="va">geomean</span>, signif <span class="op">=</span> <span class="fl">3</span>, value <span class="op">=</span> <span class="st">"Kfoc"</span>, raw <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">soil_N</span><span class="op">(</span><span class="va">chent</span>, aggregator <span class="op">=</span> <span class="va">mean</span>, signif <span class="op">=</span> <span class="fl">3</span>, raw <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">soil_sorption</span><span class="op">(</span></span>
+<span> <span class="va">chent</span>,</span>
+<span> values <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="st">"Kfoc"</span>, <span class="st">"N"</span><span class="op">)</span>,</span>
+<span> aggregators <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>Kfoc <span class="op">=</span> <span class="va">geomean</span>, Koc <span class="op">=</span> <span class="va">geomean</span>, N <span class="op">=</span> <span class="va">mean</span><span class="op">)</span>,</span>
+<span> signif <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>Kfoc <span class="op">=</span> <span class="fl">3</span>, N <span class="op">=</span> <span class="fl">3</span><span class="op">)</span>,</span>
+<span> raw <span class="op">=</span> <span class="cn">FALSE</span></span>
+<span><span class="op">)</span></span></code></pre></div>
+ </div>
+
+ <div id="arguments">
+ <h2>Arguments</h2>
+ <dl><dt>chent</dt>
+<dd><p>The chent object to get the information from</p></dd>
+
+
+<dt>medium</dt>
+<dd><p>The medium for which information is sought</p></dd>
+
+
+<dt>type</dt>
+<dd><p>The information type</p></dd>
+
+
+<dt>lab_field</dt>
+<dd><p>If not NA, do we want laboratory or field endpoints</p></dd>
+
+
+<dt>redox</dt>
+<dd><p>If not NA, are we looking for aerobic or anaerobic data</p></dd>
+
+
+<dt>value</dt>
+<dd><p>The name of the value we want. The list given in the
+usage section is not exclusive</p></dd>
+
+
+<dt>aggregator</dt>
+<dd><p>The aggregator function. Can be mean,
+<code><a href="geomean.html">geomean</a></code>, or identity, for example.</p></dd>
+
+
+<dt>raw</dt>
+<dd><p>Should the number(s) be returned as stored in the chent
object (could be a character value) to retain original information
-about precision?</p></td>
- </tr>
- <tr>
- <th>signif</th>
- <td><p>How many significant digits do we want</p></td>
- </tr>
- <tr>
- <th>values</th>
- <td><p>The values to be returned</p></td>
- </tr>
- <tr>
- <th>aggregators</th>
- <td><p>A named vector of aggregator functions to be used</p></td>
- </tr>
- </table>
-
- <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
-
- <p>The result from applying the aggregator function to
+about precision?</p></dd>
+
+
+<dt>signif</dt>
+<dd><p>How many significant digits do we want</p></dd>
+
+
+<dt>values</dt>
+<dd><p>The values to be returned</p></dd>
+
+
+<dt>aggregators</dt>
+<dd><p>A named vector of aggregator functions to be used</p></dd>
+
+</dl></div>
+ <div id="value">
+ <h2>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>
-
+ </div>
+ <div id="details">
+ <h2>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>
- <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 class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
+ <nav id="toc" data-toggle="toc" class="sticky-top"><h2 data-toc-skip>Contents</h2>
+ </nav></div>
</div>
- <footer>
- <div class="copyright">
- <p>Developed by Johannes Ranke.</p>
+ <footer><div class="copyright">
+ <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>
+ <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>

Contact - Imprint