diff options
author | Johannes Ranke <jranke@uni-bremen.de> | 2017-01-18 22:41:01 +0100 |
---|---|---|
committer | Johannes Ranke <jranke@uni-bremen.de> | 2017-01-18 22:50:14 +0100 |
commit | a76221d87485029444c8e684022ca606a0c7e68d (patch) | |
tree | c95052ee51b35f6c5ab87bd6f27ef2877f536838 /docs/reference/PEC_sw_drainage_UK.html | |
parent | a1d9f93138c2cfed92a683e37e72c737d52b7ad7 (diff) |
Update static docs using pkgdown
- Add _pkgdown.yml for a structured function/data reference
- Make seealso links active
- Make mkinfit calls quiet
- Use pkgdown branch from pull request hadley/pkgdown#229 to have topics
ordered
Diffstat (limited to 'docs/reference/PEC_sw_drainage_UK.html')
-rw-r--r-- | docs/reference/PEC_sw_drainage_UK.html | 137 |
1 files changed, 137 insertions, 0 deletions
diff --git a/docs/reference/PEC_sw_drainage_UK.html b/docs/reference/PEC_sw_drainage_UK.html new file mode 100644 index 0000000..db0f85f --- /dev/null +++ b/docs/reference/PEC_sw_drainage_UK.html @@ -0,0 +1,137 @@ +<!-- Generated by pkgdown: do not edit by hand --> +<!DOCTYPE html> +<html> + <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 initial predicted environmental concentrations in surface water due to drainage using the UK method — PEC_sw_drainage_UK • pfm</title> + +<!-- jquery --> +<script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script> +<!-- Bootstrap --> + +<link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous"> +<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script> + +<!-- Font Awesome icons --> +<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-T8Gy5hrqNKT+hzMclPo118YTQO6cYprQmhrYwIiQ/3axmI1hQomh7Ud2hPOy8SP1" crossorigin="anonymous"> + + +<!-- pkgdown --> +<link href="../pkgdown.css" rel="stylesheet"> +<script src="../jquery.sticky-kit.min.js"></script> +<script src="../pkgdown.js"></script> + +<!-- mathjax --> +<script src='https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></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> + <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"> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="../index.html">pfm</a> + </div> + <div id="navbar" class="navbar-collapse collapse"> + <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 --> + </div><!--/.container --> +</div><!--/.navbar --> + + + </header> + + <div class="row"> + <div class="col-md-9 contents"> + <div class="page-header"> + <h1>Calculate initial predicted environmental concentrations in surface water due to drainage using the UK method</h1> + </div> + + + <p>This implements the method specified in the UK data requirements handbook and was checked against the spreadsheet +published on the CRC website</p> + + + <pre><span class='fu'>PEC_sw_drainage_UK</span>(<span class='no'>rate</span>, <span class='kw'>interception</span> <span class='kw'>=</span> <span class='fl'>0</span>, <span class='no'>Koc</span>, <span class='kw'>latest_application</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, + <span class='kw'>soil_DT50</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, <span class='kw'>model</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, <span class='kw'>model_parms</span> <span class='kw'>=</span> <span class='kw'>NULL</span>)</pre> + + <h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a> Arguments</h2> + <dl class="dl-horizontal"> + <dt>rate</dt> + <dd>Application rate in g/ha</dd> + <dt>interception</dt> + <dd>The fraction of the application rate that does not reach the soil</dd> + <dt>Koc</dt> + <dd>The sorption coefficient normalised to organic carbon in L/kg</dd> + <dt>latest_application</dt> + <dd>Latest application date, formatted as e.g. "01 July"</dd> + <dt>soil_DT50</dt> + <dd>Soil degradation half-life, if SFO kinetics are to be used</dd> + <dt>model</dt> + <dd>The soil degradation model to be used. Either one of "FOMC", +"DFOP", "HS", or "IORE", or an mkinmod object</dd> + <dt>model_parms</dt> + <dd>A named numeric vector containing the model parameters</dd> + </dl> + + <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2> + + <p>The predicted concentration in surface water in µg/L</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_drainage_UK</span>(<span class='fl'>150</span>, <span class='kw'>Koc</span> <span class='kw'>=</span> <span class='fl'>100</span>)</div><div class='output co'>#> [1] 8.076923</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> + +Johannes Ranke + + </div> +</div> + + <footer> + <div class="copyright"> + <p>Developed by Johannes Ranke.</p> +</div> + +<div class="pkgdown"> + <p>Site built with <a href="http://hadley.github.io/pkgdown/">pkgdown</a>.</p> +</div> + + </footer> + </div> + + </body> +</html> |