diff options
| author | Ranke Johannes <johannes.ranke@agroscope.admin.ch> | 2024-01-31 13:16:17 +0100 |
|---|---|---|
| committer | Ranke Johannes <johannes.ranke@agroscope.admin.ch> | 2024-01-31 13:27:50 +0100 |
| commit | aed160d7f0eaf5865e2bd9bf6c4b1c9d7b13d911 (patch) | |
| tree | 7ca136834857c12449f50a1e086a589cc9b79e2e /docs/reference/PEC_sw_sed.html | |
| parent | 64f629efbe666bae56f48a309adf33d1eb09c358 (diff) | |
Reorganise data generation
- Use inst/data_generation for R code generating data as in some of my other packages
- data/*.RData files were checked using https://github.com/jranke/dotfiles/blob/main/bin/rda_diff
contents were not changed
- Remove ChangeLog, the history is in the git logs
- Update docs and some links contained therein
- use \doi{} markup
- Move logs to log directory
Diffstat (limited to 'docs/reference/PEC_sw_sed.html')
| -rw-r--r-- | docs/reference/PEC_sw_sed.html | 224 |
1 files changed, 79 insertions, 145 deletions
diff --git a/docs/reference/PEC_sw_sed.html b/docs/reference/PEC_sw_sed.html index 458eeb7..247c8d7 100644 --- a/docs/reference/PEC_sw_sed.html +++ b/docs/reference/PEC_sw_sed.html @@ -1,67 +1,15 @@ -<!-- 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"> - -<title>Calculate predicted environmental concentrations in sediment from surface -water concentrations — PEC_sw_sed • pfm</title> - - -<!-- 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 --> - -<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" /> - -<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script> - -<!-- 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" /> - -<!-- 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> - -<!-- 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> - -<!-- pkgdown --> -<link href="../pkgdown.css" rel="stylesheet"> -<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" /> -<meta name="twitter:card" content="summary" /> - - - - -<!-- 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]> +<!-- 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.0"><title>Calculate predicted environmental concentrations in sediment from surface +water concentrations — PEC_sw_sed • pfm</title><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous"><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css"><script src="../bootstrap-toc.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"><!-- 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><!-- 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><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"><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> +<![endif]--></head><body data-spy="scroll" data-target="#toc"> + - <body> <div class="container template-reference-topic"> - <header> - <div class="navbar navbar-default navbar-fixed-top" role="navigation"> + <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"> @@ -72,35 +20,21 @@ PEC calculator" /> </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 class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.6.1</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> + <ul class="nav navbar-nav"><li> <a href="../reference/index.html">Reference</a> </li> - </ul> - <ul class="nav navbar-nav navbar-right"> - - </ul> - - </div><!--/.nav-collapse --> + </ul><ul class="nav navbar-nav navbar-right"></ul></div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> - </header> - -<div class="row"> + </header><div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Calculate predicted environmental concentrations in sediment from surface @@ -114,89 +48,89 @@ water concentrations</h1> PEC calculator</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> + <div id="ref-usage"> + <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> + + <div id="arguments"> + <h2>Arguments</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> + + +<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> + + +<dt>water_depth</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 +g/cm3)</p></dd> + + +<dt>PEC_sed_units</dt> +<dd><p>The units of the estimated sediment PEC value</p></dd> + +</dl></div> + <div id="value"> + <h2>Value</h2> + + +<p>The predicted concentration in sediment</p> + </div> + <div id="author"> <h2>Author</h2> <p>Johannes Ranke</p> + </div> + + <div id="ref-examples"> + <h2>Examples</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> </div> + <div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar"> + <nav id="toc" data-toggle="toc" class="sticky-top"><h2 data-toc-skip>Contents</h2> + </nav></div> </div> - <footer> - <div class="copyright"> - <p>Developed by Johannes Ranke.</p> + <footer><div class="copyright"> + <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> + <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> |