aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/endpoint.html
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2017-05-16 15:43:50 +0200
committerJohannes Ranke <jranke@uni-bremen.de>2017-05-16 15:43:50 +0200
commit36036b5901223591e7e21e8b73d8cd1fb034f4cb (patch)
treeed8e764778aa2e94b785263d18d7d8e3dfe4e785 /docs/reference/endpoint.html
parentd042f8f06b313e8595087587455daac73d84f17b (diff)
Finish the Step 1 calculator including tests
Some cleaning up. PELMO facilities do not currently work at my end, as I have no working wine installation on this computer
Diffstat (limited to 'docs/reference/endpoint.html')
-rw-r--r--docs/reference/endpoint.html83
1 files changed, 54 insertions, 29 deletions
diff --git a/docs/reference/endpoint.html b/docs/reference/endpoint.html
index 57a7652..1cc4da4 100644
--- a/docs/reference/endpoint.html
+++ b/docs/reference/endpoint.html
@@ -25,12 +25,14 @@
<script src="../pkgdown.js"></script>
<!-- mathjax -->
-<script src='https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script>
+<script src='https://mathjax.rstudio.com/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>
@@ -76,7 +78,7 @@ 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>),
+ <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'>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>)
@@ -95,34 +97,57 @@ this function.</p>
<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
+ <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
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>
+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>

Contact - Imprint