diff options
Diffstat (limited to 'docs/reference/PEC_sw_sed.html')
| -rw-r--r-- | docs/reference/PEC_sw_sed.html | 90 |
1 files changed, 40 insertions, 50 deletions
diff --git a/docs/reference/PEC_sw_sed.html b/docs/reference/PEC_sw_sed.html index c4b0fd8..6d377c9 100644 --- a/docs/reference/PEC_sw_sed.html +++ b/docs/reference/PEC_sw_sed.html @@ -1,48 +1,36 @@ <!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 method 'percentage' is equivalent to what is used in the CRD spreadsheet -PEC calculator"><title>Calculate predicted environmental concentrations in sediment from surface -water concentrations — PEC_sw_sed • 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="Calculate predicted environmental concentrations in sediment from surface -water concentrations — PEC_sw_sed"><meta property="og:description" content="The method 'percentage' is equivalent to what is used in the CRD spreadsheet -PEC calculator"><!-- 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> +<!-- 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>Calculate predicted environmental concentrations in sediment from surface water concentrations — PEC_sw_sed • 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="Calculate predicted environmental concentrations in sediment from surface water concentrations — PEC_sw_sed"><meta name="description" content="The method 'percentage' is equivalent to what is used in the CRD spreadsheet +PEC calculator"><meta property="og:description" content="The method 'percentage' is equivalent to what is used in the CRD spreadsheet +PEC calculator"></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>Calculate predicted environmental concentrations in sediment from surface -water concentrations</h1> + + <h1>Calculate predicted environmental concentrations in sediment from surface water concentrations</h1> <small class="dont-index">Source: <a href="https://github.com/jranke/pfm/blob/HEAD/R/PEC_sw_sed.R" class="external-link"><code>R/PEC_sw_sed.R</code></a></small> <div class="d-none name"><code>PEC_sw_sed.Rd</code></div> </div> @@ -58,50 +46,50 @@ PEC calculator</p> <span> <span class="va">PEC_sw</span>,</span> <span> percentage <span class="op">=</span> <span class="fl">100</span>,</span> <span> method <span class="op">=</span> <span class="st">"percentage"</span>,</span> -<span> sediment_depth <span class="op">=</span> <span class="fl">5</span>,</span> -<span> water_depth <span class="op">=</span> <span class="fl">30</span>,</span> -<span> sediment_density <span class="op">=</span> <span class="fl">1.3</span>,</span> +<span> sediment_depth <span class="op">=</span> <span class="fu">set_units</span><span class="op">(</span><span class="fl">5</span>, <span class="st">"cm"</span><span class="op">)</span>,</span> +<span> water_depth <span class="op">=</span> <span class="fu">set_units</span><span class="op">(</span><span class="fl">30</span>, <span class="st">"cm"</span><span class="op">)</span>,</span> +<span> sediment_density <span class="op">=</span> <span class="fu">set_units</span><span class="op">(</span><span class="fl">1.3</span>, <span class="st">"kg/L"</span><span class="op">)</span>,</span> <span> PEC_sed_units <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">"µg/kg"</span>, <span class="st">"mg/kg"</span><span class="op">)</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>PEC_sw</dt> + + +<dl><dt id="arg-pec-sw">PEC_sw<a class="anchor" aria-label="anchor" href="#arg-pec-sw"></a></dt> <dd><p>Numeric vector or matrix of surface water concentrations in µg/L for which the corresponding sediment concentration is to be estimated</p></dd> -<dt>percentage</dt> +<dt id="arg-percentage">percentage<a class="anchor" aria-label="anchor" href="#arg-percentage"></a></dt> <dd><p>The percentage in sediment, used for the percentage method</p></dd> -<dt>method</dt> +<dt id="arg-method">method<a class="anchor" aria-label="anchor" href="#arg-method"></a></dt> <dd><p>The method used for the calculation</p></dd> -<dt>sediment_depth</dt> +<dt id="arg-sediment-depth">sediment_depth<a class="anchor" aria-label="anchor" href="#arg-sediment-depth"></a></dt> <dd><p>Depth of the sediment layer</p></dd> -<dt>water_depth</dt> +<dt id="arg-water-depth">water_depth<a class="anchor" aria-label="anchor" href="#arg-water-depth"></a></dt> <dd><p>Depth of the water body in cm</p></dd> -<dt>sediment_density</dt> -<dd><p>The density of the sediment in L/kg (equivalent to +<dt id="arg-sediment-density">sediment_density<a class="anchor" aria-label="anchor" href="#arg-sediment-density"></a></dt> +<dd><p>The density of the sediment in kg/L (equivalent to g/cm3)</p></dd> -<dt>PEC_sed_units</dt> +<dt id="arg-pec-sed-units">PEC_sed_units<a class="anchor" aria-label="anchor" href="#arg-pec-sed-units"></a></dt> <dd><p>The units of the estimated sediment PEC value</p></dd> </dl></div> <div class="section level2"> <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2> - - -<p>The predicted concentration in sediment</p> + <p>The predicted concentration in sediment</p> </div> <div class="section level2"> <h2 id="author">Author<a class="anchor" aria-label="anchor" href="#author"></a></h2> @@ -110,28 +98,30 @@ g/cm3)</p></dd> <div class="section level2"> <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="fu">PEC_sw_sed</span><span class="op">(</span><span class="fu"><a href="PEC_sw_drift.html">PEC_sw_drift</a></span><span class="op">(</span><span class="fl">100</span>, distances <span class="op">=</span> <span class="fl">1</span><span class="op">)</span>, percentage <span class="op">=</span> <span class="fl">50</span><span class="op">)</span></span></span> -<span class="r-out co"><span class="r-pr">#></span> 1 m </span> -<span class="r-out co"><span class="r-pr">#></span> 2.130769 </span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://pkgdown.jrwb.de/pfm">pfm</a></span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://r-quantities.github.io/units/" class="external-link">units</a></span><span class="op">)</span></span></span> +<span class="r-msg co"><span class="r-pr">#></span> udunits database from /usr/share/xml/udunits/udunits2.xml</span> +<span class="r-in"><span><span class="fu">PEC_sw_sed</span><span class="op">(</span><span class="fu"><a href="PEC_sw_drift.html">PEC_sw_drift</a></span><span class="op">(</span><span class="fl">100</span>, distances <span class="op">=</span> <span class="fl">1</span><span class="op">)</span>, percentage <span class="op">=</span> <span class="fl">50</span><span class="op">)</span></span></span> +<span class="r-out co"><span class="r-pr">#></span> 2.130769 [µg/kg]</span> </code></pre></div> </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> |