aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/PEC_sw_sed.html
blob: 6d377c94b050f952cbc494f76cf6102188ef1657 (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
<!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"><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 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.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>
<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">

      <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>

    <div class="ref-description section level2">
    <p>The method 'percentage' is equivalent to what is used in the CRD spreadsheet
PEC calculator</p>
    </div>

    <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="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 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 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 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 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 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 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 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>
    </div>
    <div class="section level2">
    <h2 id="author">Author<a class="anchor" aria-label="anchor" href="#author"></a></h2>
    <p>Johannes Ranke</p>
    </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="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">#&gt;</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">#&gt;</span> 2.130769 [µg/kg]</span>
</code></pre></div>
    </div>
  </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>Developed by Johannes Ranke.</p>
</div>

<div class="pkgdown-footer-right">
  <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>

Contact - Imprint