aboutsummaryrefslogtreecommitdiff
path: root/docs/PEC_sw_sed.html
blob: 8161eda8da237805c556064846df14e82bee9efe (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
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>

Contact - Imprint