diff options
Diffstat (limited to 'docs/reference/GUS.html')
| -rw-r--r-- | docs/reference/GUS.html | 87 |
1 files changed, 39 insertions, 48 deletions
diff --git a/docs/reference/GUS.html b/docs/reference/GUS.html index 7638dcd..a613d98 100644 --- a/docs/reference/GUS.html +++ b/docs/reference/GUS.html @@ -1,47 +1,38 @@ <!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="The groundwater ubiquity score GUS is calculated according to +<!-- 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>Groundwater ubiquity score based on Gustafson (1989) — GUS • 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="Groundwater ubiquity score based on Gustafson (1989) — GUS"><meta name="description" content="The groundwater ubiquity score GUS is calculated according to the following equation -$$GUS = \log_{10} DT50_{soil} (4 - \log_{10} K_{oc})$$"><title>Groundwater ubiquity score based on Gustafson (1989) — GUS • 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="Groundwater ubiquity score based on Gustafson (1989) — GUS"><meta property="og:description" content="The groundwater ubiquity score GUS is calculated according to +$$GUS = \log_{10} DT50_{soil} (4 - \log_{10} K_{oc})$$"><meta property="og:description" content="The groundwater ubiquity score GUS is calculated according to the following equation -$$GUS = \log_{10} DT50_{soil} (4 - \log_{10} K_{oc})$$"><!-- 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> +$$GUS = \log_{10} DT50_{soil} (4 - \log_{10} K_{oc})$$"></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>Groundwater ubiquity score based on Gustafson (1989)</h1> + + <h1>Groundwater ubiquity score based on Gustafson (1989)</h1> <small class="dont-index">Source: <a href="https://github.com/jranke/pfm/blob/HEAD/R/GUS.R" class="external-link"><code>R/GUS.R</code></a></small> <div class="d-none name"><code>GUS.Rd</code></div> </div> @@ -56,10 +47,10 @@ $$GUS = \log_{10} DT50_{soil} (4 - \log_{10} K_{oc})$$</p> <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">GUS</span><span class="op">(</span><span class="va">...</span><span class="op">)</span></span> <span></span> -<span><span class="co"># S3 method for numeric</span></span> +<span><span class="co"># S3 method for class 'numeric'</span></span> <span><span class="fu">GUS</span><span class="op">(</span><span class="va">DT50</span>, <span class="va">Koc</span>, <span class="va">...</span><span class="op">)</span></span> <span></span> -<span><span class="co"># S3 method for chent</span></span> +<span><span class="co"># S3 method for class 'chent'</span></span> <span><span class="fu">GUS</span><span class="op">(</span></span> <span> <span class="va">chent</span>,</span> <span> degradation_value <span class="op">=</span> <span class="st">"DT50ref"</span>,</span> @@ -71,18 +62,20 @@ $$GUS = \log_{10} DT50_{soil} (4 - \log_{10} K_{oc})$$</p> <span> <span class="va">...</span></span> <span><span class="op">)</span></span> <span></span> -<span><span class="co"># S3 method for GUS_result</span></span> +<span><span class="co"># S3 method for class 'GUS_result'</span></span> <span><span class="fu"><a href="https://rdrr.io/r/base/print.html" class="external-link">print</a></span><span class="op">(</span><span class="va">x</span>, <span class="va">...</span>, digits <span class="op">=</span> <span class="fl">1</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>...</dt> + + +<dl><dt id="arg--">...<a class="anchor" aria-label="anchor" href="#arg--"></a></dt> <dd><p>Included in the generic to allow for further arguments later. Therefore this also had to be added to the specific methods.</p></dd> -<dt>DT50</dt> +<dt id="arg-dt-">DT50<a class="anchor" aria-label="anchor" href="#arg-dt-"></a></dt> <dd><p>Half-life of the chemical in soil. Should be a field half-life according to Gustafson (1989). However, leaching to the sub-soil can not completely be excluded in field dissipation experiments and Gustafson @@ -90,7 +83,7 @@ did not refer to any normalisation procedure, but says the field study should be conducted under use conditions.</p></dd> -<dt>Koc</dt> +<dt id="arg-koc">Koc<a class="anchor" aria-label="anchor" href="#arg-koc"></a></dt> <dd><p>The sorption constant normalised to organic carbon. Gustafson does not mention the nonlinearity of the sorption constant commonly found and usually described by Freundlich sorption, therefore it is @@ -98,17 +91,17 @@ unclear at which reference concentration the Koc should be observed (and if the reference concentration would be in soil or in porewater).</p></dd> -<dt>chent</dt> +<dt id="arg-chent">chent<a class="anchor" aria-label="anchor" href="#arg-chent"></a></dt> <dd><p>If a chent is given with appropriate information present in its chyaml field, this information is used, with defaults specified below.</p></dd> -<dt>degradation_value</dt> +<dt id="arg-degradation-value">degradation_value<a class="anchor" aria-label="anchor" href="#arg-degradation-value"></a></dt> <dd><p>Which of the available degradation values should be used?</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>Should laboratory or field half-lives be used? This defaults to lab in this implementation, in order to avoid double-accounting for mobility. If comparability with the original GUS @@ -116,11 +109,11 @@ values given by Gustafson (1989) is desired, non-normalised first-order field half-lives obtained under actual use conditions should be used.</p></dd> -<dt>redox</dt> +<dt id="arg-redox">redox<a class="anchor" aria-label="anchor" href="#arg-redox"></a></dt> <dd><p>Aerobic or anaerobic degradation data</p></dd> -<dt>sorption_value</dt> +<dt id="arg-sorption-value">sorption_value<a class="anchor" aria-label="anchor" href="#arg-sorption-value"></a></dt> <dd><p>Which of the available sorption values should be used? Defaults to Kfoc as this is what is generally available from the European pesticide peer review process. These values generally use a reference @@ -128,27 +121,25 @@ concentration of 1 mg/L in porewater, that means they would be expected to be Koc values at a concentration of 1 mg/L in the water phase.</p></dd> -<dt>degradation_aggregator</dt> +<dt id="arg-degradation-aggregator">degradation_aggregator<a class="anchor" aria-label="anchor" href="#arg-degradation-aggregator"></a></dt> <dd><p>Function for aggregating half-lives</p></dd> -<dt>sorption_aggregator</dt> +<dt id="arg-sorption-aggregator">sorption_aggregator<a class="anchor" aria-label="anchor" href="#arg-sorption-aggregator"></a></dt> <dd><p>Function for aggregation Koc values</p></dd> -<dt>x</dt> +<dt id="arg-x">x<a class="anchor" aria-label="anchor" href="#arg-x"></a></dt> <dd><p>An object of class GUS_result to be printed</p></dd> -<dt>digits</dt> +<dt id="arg-digits">digits<a class="anchor" aria-label="anchor" href="#arg-digits"></a></dt> <dd><p>The number of digits used in the print method</p></dd> </dl></div> <div class="section level2"> <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2> - - -<p>A list with the DT50 and Koc used as well as the resulting score + <p>A list with the DT50 and Koc used as well as the resulting score of class GUS_result</p> </div> <div class="section level2"> @@ -162,23 +153,23 @@ toxicology and chemistry</em> <b>8</b>(4) 339–57.</p> <p>Johannes Ranke</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> |