aboutsummaryrefslogtreecommitdiff
path: root/docs/PEC_sw_sed.html
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2016-09-27 23:00:48 +0200
committerJohannes Ranke <jranke@uni-bremen.de>2016-09-27 23:00:48 +0200
commit12a31f4c130c551f82232d9ef7dfb608bd52c53f (patch)
tree2525ab1ea4102a6edddbd0c2f03f4a851bf2f9c5 /docs/PEC_sw_sed.html
parent0d958ab6f84b569b5437f231c56004890c4ae23b (diff)
Reorganise repository using standard package layout
Diffstat (limited to 'docs/PEC_sw_sed.html')
-rw-r--r--docs/PEC_sw_sed.html131
1 files changed, 131 insertions, 0 deletions
diff --git a/docs/PEC_sw_sed.html b/docs/PEC_sw_sed.html
new file mode 100644
index 0000000..8161eda
--- /dev/null
+++ b/docs/PEC_sw_sed.html
@@ -0,0 +1,131 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+<title>PEC_sw_sed. pfm 0.3-8</title>
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<meta name="author" content="
+Johannes Ranke
+">
+
+<link href="css/bootstrap.css" rel="stylesheet">
+<link href="css/bootstrap-responsive.css" rel="stylesheet">
+<link href="css/highlight.css" rel="stylesheet">
+<link href="css/staticdocs.css" rel="stylesheet">
+
+<!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+<![endif]-->
+
+<script type="text/x-mathjax-config">
+ MathJax.Hub.Config({
+ tex2jax: {
+ inlineMath: [ ['$','$'], ["\\(","\\)"] ],
+ processEscapes: true
+ }
+ });
+</script>
+<script type="text/javascript"
+ src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
+</script>
+ </head>
+
+ <body>
+ <div class="navbar">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="brand" href="index.html">pfm 0.3-8</a>
+ <div class="nav">
+ <ul class="nav">
+ <li><a href="index.html">Home</a></li>
+ <li><a href="reference.html">Reference</a></li>
+ </ul>
+ </div>
+ </div>
+ </div>
+</div>
+
+
+ <div class="container">
+ <header>
+
+ </header>
+
+ <h1>Calculate predicted environmental concentrations in sediment from surface
+water concentrations</h1>
+
+<div class="row">
+ <div class="span8">
+ <h2>Usage</h2>
+ <pre><span class="functioncall"><a href='PEC_sw_sed.html'>PEC_sw_sed</a></span><span class="keyword">(</span><span class="symbol">PEC_sw</span><span class="keyword">,</span> <span class="argument">percentage</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="number">100</span><span class="keyword">,</span> <span class="argument">method</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="string">"percentage"</span><span class="keyword">,</span>
+ <span class="argument">sediment_depth</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="number">5</span><span class="keyword">,</span> <span class="argument">water_depth</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="number">30</span><span class="keyword">,</span> <span class="argument">sediment_density</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="number">1.3</span><span class="keyword">,</span>
+ <span class="argument">PEC_sed_units</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="functioncall"><a href='http://www.rdocumentation.org/packages/base/topics/c'>c</a></span><span class="keyword">(</span><span class="string">"µg/kg"</span><span class="keyword">,</span> <span class="string">"mg/kg"</span><span class="keyword">)</span><span class="keyword">)</span></pre>
+
+ <h2>Arguments</h2>
+ <dl>
+ <dt>PEC_sw</dt>
+ <dd>Numeric vector or matrix of surface water concentrations in µg/L for
+which the corresponding sediment concentration is to be estimated</dd>
+ <dt>percentage</dt>
+ <dd>The percentage in sediment, used for the percentage method</dd>
+ <dt>method</dt>
+ <dd>The method used for the calculation</dd>
+ <dt>sediment_depth</dt>
+ <dd>Depth of the sediment layer</dd>
+ <dt>water_depth</dt>
+ <dd>Depth of the water body in cm</dd>
+ <dt>sediment_density</dt>
+ <dd>The density of the sediment in L/kg (equivalent to
+g/cm3)</dd>
+ <dt>PEC_sed_units</dt>
+ <dd>The units of the estimated sediment PEC value</dd>
+ </dl>
+
+ <div class="Value">
+ <h2>Value</h2>
+
+ <p><dl>
+The predicted concentration in sediment
+</dl></p>
+
+ </div>
+
+ <div class="Description">
+ <h2>Description</h2>
+
+ <p>The method &#39;percentage&#39; is equivalent to what is used in the CRD spreadsheet
+PEC calculator</p>
+
+ </div>
+
+ <h2 id="examples">Examples</h2>
+ <pre class="examples"><div class='input'><span class="functioncall"><a href='PEC_sw_sed.html'>PEC_sw_sed</a></span><span class="keyword">(</span><span class="functioncall"><a href='PEC_sw_drift.html'>PEC_sw_drift</a></span><span class="keyword">(</span><span class="number">100</span><span class="keyword">,</span> <span class="argument">distances</span> <span class="argument">=</span> <span class="number">1</span><span class="keyword">)</span><span class="keyword">,</span> <span class="argument">percentage</span> <span class="argument">=</span> <span class="number">50</span><span class="keyword">)</span></div>
+<div class='output'> 1 m
+2.130769
+</div></pre>
+ </div>
+ <div class="span4 sidebar">
+ <!-- <ul>
+ <li>PEC_sw_sed</li>
+ </ul>
+ <ul>
+
+ </ul> -->
+
+
+
+ <h2>Author</h2>
+
+Johannes Ranke
+
+
+ </div>
+</div>
+
+ <footer>
+ <p class="pull-right"><a href="#">Back to top</a></p>
+<p>Built by <a href="https://github.com/hadley/staticdocs">staticdocs</a>. Styled with <a href="https://getbootstrap.com/2.0.4/">bootstrap</a>.</p>
+ </footer>
+ </div>
+ </body>
+</html> \ No newline at end of file

Contact - Imprint