diff options
Diffstat (limited to 'docs/reference/PEC_sw_sed.html')
| -rw-r--r-- | docs/reference/PEC_sw_sed.html | 263 |
1 files changed, 99 insertions, 164 deletions
diff --git a/docs/reference/PEC_sw_sed.html b/docs/reference/PEC_sw_sed.html index 458eeb7..3432a75 100644 --- a/docs/reference/PEC_sw_sed.html +++ b/docs/reference/PEC_sw_sed.html @@ -1,202 +1,137 @@ -<!-- 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"> +<!-- 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.2.2/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.2.2/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> + <a href="#main" class="visually-hidden-focusable">Skip to contents</a> + -<title>Calculate predicted environmental concentrations in sediment from surface -water concentrations — PEC_sw_sed • pfm</title> + <nav class="navbar fixed-top navbar-light navbar-expand-lg bg-light"><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.0</small> -<!-- 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 --> + + <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> -<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" /> + <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> -<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script> + <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></div> -<!-- 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" /> + + </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> + <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> -<!-- 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> + <div class="ref-description section level2"> + <p>The method 'percentage' is equivalent to what is used in the CRD spreadsheet +PEC calculator</p> + </div> -<!-- 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> + <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">PEC_sw_sed</span><span class="op">(</span></span> +<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> 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> -<!-- pkgdown --> -<link href="../pkgdown.css" rel="stylesheet"> -<script src="../pkgdown.js"></script> + <div class="section level2"> + <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2> + <dl><dt>PEC_sw</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> +<dd><p>The percentage in sediment, used for the percentage method</p></dd> -<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" /> -<meta name="twitter:card" content="summary" /> +<dt>method</dt> +<dd><p>The method used for the calculation</p></dd> +<dt>sediment_depth</dt> +<dd><p>Depth of the sediment layer</p></dd> -<!-- 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> +<dt>water_depth</dt> +<dd><p>Depth of the water body in cm</p></dd> -<!--[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 --> +<dt>sediment_density</dt> +<dd><p>The density of the sediment in L/kg (equivalent to +g/cm3)</p></dd> - - </header> +<dt>PEC_sed_units</dt> +<dd><p>The units of the estimated sediment PEC value</p></dd> -<div class="row"> - <div class="col-md-9 contents"> - <div class="page-header"> - <h1>Calculate predicted environmental concentrations in sediment from surface -water concentrations</h1> +</dl></div> + <div class="section level2"> + <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2> - <div class="hidden name"><code>PEC_sw_sed.Rd</code></div> - </div> - <div class="ref-description"> - <p>The method 'percentage' is equivalent to what is used in the CRD spreadsheet -PEC calculator</p> +<p>The predicted concentration in sediment</p> </div> - - <pre class="usage"><span class='fu'>PEC_sw_sed</span>( - <span class='no'>PEC_sw</span>, - <span class='kw'>percentage</span> <span class='kw'>=</span> <span class='fl'>100</span>, - <span class='kw'>method</span> <span class='kw'>=</span> <span class='st'>"percentage"</span>, - <span class='kw'>sediment_depth</span> <span class='kw'>=</span> <span class='fl'>5</span>, - <span class='kw'>water_depth</span> <span class='kw'>=</span> <span class='fl'>30</span>, - <span class='kw'>sediment_density</span> <span class='kw'>=</span> <span class='fl'>1.3</span>, - <span class='kw'>PEC_sed_units</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='st'>"µg/kg"</span>, <span class='st'>"mg/kg"</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>PEC_sw</th> - <td><p>Numeric vector or matrix of surface water concentrations in µg/L for -which the corresponding sediment concentration is to be estimated</p></td> - </tr> - <tr> - <th>percentage</th> - <td><p>The percentage in sediment, used for the percentage method</p></td> - </tr> - <tr> - <th>method</th> - <td><p>The method used for the calculation</p></td> - </tr> - <tr> - <th>sediment_depth</th> - <td><p>Depth of the sediment layer</p></td> - </tr> - <tr> - <th>water_depth</th> - <td><p>Depth of the water body in cm</p></td> - </tr> - <tr> - <th>sediment_density</th> - <td><p>The density of the sediment in L/kg (equivalent to -g/cm3)</p></td> - </tr> - <tr> - <th>PEC_sed_units</th> - <td><p>The units of the estimated sediment PEC value</p></td> - </tr> - </table> - - <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2> - - <p>The predicted concentration in sediment</p> - - <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2> - <pre class="examples"><div class='input'><span class='fu'>PEC_sw_sed</span>(<span class='fu'><a href='PEC_sw_drift.html'>PEC_sw_drift</a></span>(<span class='fl'>100</span>, <span class='kw'>distances</span> <span class='kw'>=</span> <span class='fl'>1</span>), <span class='kw'>percentage</span> <span class='kw'>=</span> <span class='fl'>50</span>)</div><div class='output co'>#> 1 m -#> 2.130769 </div></pre> - </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="#examples">Examples</a></li> - </ul> - - <h2>Author</h2> + <div class="section level2"> + <h2 id="author">Author<a class="anchor" aria-label="anchor" href="#author"></a></h2> <p>Johannes Ranke</p> - </div> -</div> + </div> + + <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> +</code></pre></div> + </div> + </main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2> + </nav></aside></div> - <footer> - <div class="copyright"> - <p>Developed by Johannes Ranke.</p> + <footer><div class="pkgdown-footer-left"> + <p></p><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 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> </div> - </footer> - </div> + </footer></div> + - </body> -</html> - + </body></html> |