1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
|
<!-- 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
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]>
<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" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</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>
</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>
<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 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'><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
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
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="https://pkgdown.r-lib.org/">pkgdown</a> 1.4.1.</p>
</div>
</footer>
</div>
</body>
</html>
|
