diff options
Diffstat (limited to 'docs/reference/endpoint.html')
| -rw-r--r-- | docs/reference/endpoint.html | 79 |
1 files changed, 35 insertions, 44 deletions
diff --git a/docs/reference/endpoint.html b/docs/reference/endpoint.html index 6705770..228d77f 100644 --- a/docs/reference/endpoint.html +++ b/docs/reference/endpoint.html @@ -1,49 +1,40 @@ <!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"><meta name="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, 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."><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><!-- 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"><!-- bootstrap-toc --><script src="https://cdn.jsdelivr.net/gh/afeld/bootstrap-toc@v1.0.1/dist/bootstrap-toc.min.js" integrity="sha256-4veVQbu7//Lk5TSmc7YV48MxtMy98e26cf5MrgZYnwo=" 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><!-- 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><!-- search --><script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.js" integrity="sha512-zv6Ywkjyktsohkbp9bb45V6tEMoWhzFzXis+LrMehmJZZSys19Yxf1dopHx7WzIKxr5tK2dVcYmaCk2uqdjF4A==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js" integrity="sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js" integrity="sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww==" crossorigin="anonymous"></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 property="og:description" content="R6 class objects of class chent represent chemical entities +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."><!-- 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> +this function."></head><body> <a href="#main" class="visually-hidden-focusable">Skip to contents</a> - - <nav class="navbar fixed-top navbar-light navbar-expand-lg bg-light"><div class="container"> - + + <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.1</small> + <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> - </ul><form class="form-inline my-2 my-lg-0" role="search"> - <input type="search" class="form-control me-sm-2" aria-label="Toggle navigation" name="search-input" data-search-index="../search.json" id="search-input" placeholder="Search for" autocomplete="off"></form> - - <ul class="navbar-nav"><li class="nav-item"> - <a class="external-link nav-link" href="https://github.com/jranke/pfm/" aria-label="github"> - <span class="fab fa fab fa-github fa-lg"></span> - - </a> -</li> + <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"> - <img src="" class="logo" alt=""><h1>Retrieve endpoint information from the chyaml field of a chent object</h1> + + <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> @@ -94,59 +85,59 @@ this function.</p> <div class="section level2"> <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2> - <dl><dt>chent</dt> + + +<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>medium</dt> +<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>type</dt> +<dt id="arg-type">type<a class="anchor" aria-label="anchor" href="#arg-type"></a></dt> <dd><p>The information type</p></dd> -<dt>lab_field</dt> +<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>redox</dt> +<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>value</dt> +<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>aggregator</dt> +<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>raw</dt> +<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>signif</dt> +<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>values</dt> +<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>aggregators</dt> +<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 + <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 @@ -160,23 +151,23 @@ 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"><h2>On this page</h2> + </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></p><p>Developed by Johannes Ranke.</p> + <p>Developed by Johannes Ranke.</p> </div> <div class="pkgdown-footer-right"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> + <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> |