aboutsummaryrefslogblamecommitdiff
path: root/docs/reference/endpoint.html
blob: 228d77f8e57c6e31713848cad765bcdf1228be1f (plain) (tree)
1
2
3
4
5
6
7
8
9
               
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   

                                                                            
                                                                                                                    

                                                                            
                             
                                                                          
 


                                                                                                                                      
                                                             
 

                                                                                                                         
 


                                                                                                                                                                                
 
                                                           




                                                                                                                                                                                                     
                 
 
 



                                                            

                                                                                    

                                                                                                                                                                  

          
                                                



                                                                            
          
 

                                                                                             


































                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                 


                                                                                             


                                                            
                                                                                            


                                                          
                                                                                      


                                    
                                                                                                     


                                                                   
                                                                                         


                                                                       
                                                                                         
                                                           


                                       
                                                                                                        
                                            


                                                                                   
                                                                                   
                                                              
                                                                  


                         
                                                                                            


                                                      
                                                                                            


                                         
                                                                                                           


                                                                 

                                                                                     
                                                          



                                                        


                                                                                           



                                                                                          
          
 
                                                                                                   
                        
 
 
                                             
                                     

      
                                  
                                                                                                      
      
 
                   
 
 

 
 
                
 
<!DOCTYPE html>
<!-- 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, shrink-to-fit=no"><title>Retrieve endpoint information from the chyaml field of a chent object — endpoint • pfm</title><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Retrieve endpoint information from the chyaml field of a chent object — endpoint"><meta name="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 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."></head><body>
    <a href="#main" class="visually-hidden-focusable">Skip to contents</a>


    <nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container">

    <a class="navbar-brand me-2" href="../index.html">pfm</a>

    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.3</small>


    <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
      <span class="navbar-toggler-icon"></span>
    </button>

    <div id="navbar" class="collapse navbar-collapse ms-3">
      <ul class="navbar-nav me-auto"><li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
<li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li>
      </ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
 <input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
<li class="nav-item"><a class="external-link nav-link" href="https://github.com/jranke/pfm/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li>
      </ul></div>


  </div>
</nav><div class="container template-reference-topic">
<div class="row">
  <main id="main" class="col-md-9"><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/HEAD/R/endpoint.R" class="external-link"><code>R/endpoint.R</code></a></small>
      <div class="d-none name"><code>endpoint.Rd</code></div>
    </div>

    <div class="ref-description section level2">
    <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>

    <div class="section level2">
    <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
    <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 class="section level2">
    <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>


<dl><dt id="arg-chent">chent<a class="anchor" aria-label="anchor" href="#arg-chent"></a></dt>
<dd><p>The chent object to get the information from</p></dd>


<dt id="arg-medium">medium<a class="anchor" aria-label="anchor" href="#arg-medium"></a></dt>
<dd><p>The medium for which information is sought</p></dd>


<dt id="arg-type">type<a class="anchor" aria-label="anchor" href="#arg-type"></a></dt>
<dd><p>The information type</p></dd>


<dt id="arg-lab-field">lab_field<a class="anchor" aria-label="anchor" href="#arg-lab-field"></a></dt>
<dd><p>If not NA, do we want laboratory or field endpoints</p></dd>


<dt id="arg-redox">redox<a class="anchor" aria-label="anchor" href="#arg-redox"></a></dt>
<dd><p>If not NA, are we looking for aerobic or anaerobic data</p></dd>


<dt id="arg-value">value<a class="anchor" aria-label="anchor" href="#arg-value"></a></dt>
<dd><p>The name of the value we want. The list given in the
usage section is not exclusive</p></dd>


<dt id="arg-aggregator">aggregator<a class="anchor" aria-label="anchor" href="#arg-aggregator"></a></dt>
<dd><p>The aggregator function. Can be mean,
<code><a href="geomean.html">geomean</a></code>, or identity, for example.</p></dd>


<dt id="arg-raw">raw<a class="anchor" aria-label="anchor" href="#arg-raw"></a></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></dd>


<dt id="arg-signif">signif<a class="anchor" aria-label="anchor" href="#arg-signif"></a></dt>
<dd><p>How many significant digits do we want</p></dd>


<dt id="arg-values">values<a class="anchor" aria-label="anchor" href="#arg-values"></a></dt>
<dd><p>The values to be returned</p></dd>


<dt id="arg-aggregators">aggregators<a class="anchor" aria-label="anchor" href="#arg-aggregators"></a></dt>
<dd><p>A named vector of aggregator functions to be used</p></dd>

</dl></div>
    <div class="section level2">
    <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></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>
    </div>
    <div class="section level2">
    <h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></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>

  </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
    </nav></aside></div>


    <footer><div class="pkgdown-footer-left">
  <p>Developed by Johannes Ranke.</p>
</div>

<div class="pkgdown-footer-right">
  <p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.0.</p>
</div>

    </footer></div>





  </body></html>

Contact - Imprint