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.html37
1 files changed, 30 insertions, 7 deletions
diff --git a/docs/reference/endpoint.html b/docs/reference/endpoint.html
index 2b6e77d..2a36788 100644
--- a/docs/reference/endpoint.html
+++ b/docs/reference/endpoint.html
@@ -21,12 +21,15 @@
<!-- clipboard.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.7.1/clipboard.min.js" integrity="sha384-cV+rhyOuRHc9Ub/91rihWcGmMmCXDeksTtCihMupQHSsi8GIIRDG0ThDc3HGQFJ3" crossorigin="anonymous"></script>
+<!-- sticky kit -->
+<script src="https://cdnjs.cloudflare.com/ajax/libs/sticky-kit/1.1.3/sticky-kit.min.js" integrity="sha256-c4Rlo1ZozqTPE2RLuvbusY3+SU1pQaJC0TjuhygMipw=" crossorigin="anonymous"></script>
+
<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
-<script src="../jquery.sticky-kit.min.js"></script>
<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
@@ -34,6 +37,9 @@ 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://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script>
@@ -56,8 +62,12 @@ this function." />
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
- <a class="navbar-brand" href="../index.html">pfm</a>
+ <span class="navbar-brand">
+ <a class="navbar-link" href="../index.html">pfm</a>
+ <span class="label label-default" data-toggle="tooltip" data-placement="bottom" title="Released package">0.4.5</span>
+ </span>
</div>
+
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
@@ -72,8 +82,14 @@ this function." />
</ul>
<ul class="nav navbar-nav navbar-right">
-
+ <li>
+ <a href="https://github.com/jranke/pfm">
+ <span class="fa fa-github fa-lg"></span>
+
+ </a>
+</li>
</ul>
+
</div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
@@ -81,18 +97,22 @@ this function." />
</header>
- <div class="row">
+<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>
+ <small class="dont-index">Source: <a href='https://github.com/jranke/pfm/blob/master/R/endpoint.R'><code>R/endpoint.R</code></a></small>
+ <div class="hidden name"><code>endpoint.Rd</code></div>
</div>
+ <div class="ref-description">
<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>
+ </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'>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>,
@@ -112,7 +132,7 @@ this function.</p>
<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>
+ <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>
@@ -207,5 +227,8 @@ exponent is often called 1/n.</p>
</footer>
</div>
+
+
</body>
</html>
+

Contact - Imprint