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/index.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/index.html')
-rw-r--r-- | docs/reference/index.html | 195 |
1 files changed, 195 insertions, 0 deletions
diff --git a/docs/reference/index.html b/docs/reference/index.html new file mode 100644 index 0000000..e458048 --- /dev/null +++ b/docs/reference/index.html @@ -0,0 +1,195 @@ +<!-- 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>Function reference • 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-index"> + <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"> + <div class="page-header"> + <h1>Function reference</h1> + <h4>version 0.4-1</h4> + </div> + + <div class="contents"> + <h2 id="section-general-utility-functions" class="hasAnchor"><a href="#section-general-utility-functions" class="anchor"></a>General utility functions</h2> + <p class="section-desc"><p>Functions that are independent of specific fate modelling areas</p></p> + + + <p><a href="geomean.html">Calculate the geometric mean</a></p> + <ul> + <li><code><a href="geomean.html">geomean</a></code></li> + </ul> + + <p><a href="one_box.html">Create a time series of decline data</a></p> + <ul> + <li><code><a href="one_box.html">one_box</a></code></li><li><code><a href="one_box.html">one_box.numeric</a></code></li><li><code><a href="one_box.html">one_box.mkinfit</a></code></li> + </ul> + + <p><a href="plot.one_box.html">Plot time series of decline data</a></p> + <ul> + <li><code><a href="plot.one_box.html">plot.one_box</a></code></li> + </ul> + + <p><a href="sawtooth.html">Create decline time series for multiple applications</a></p> + <ul> + <li><code><a href="sawtooth.html">sawtooth</a></code></li> + </ul> + + <p><a href="twa.html">Calculate a time weighted average concentration</a></p> + <ul> + <li><code><a href="twa.html">twa</a></code></li><li><code><a href="twa.html">twa.one_box</a></code></li> + </ul> + + <p><a href="max_twa.html">The maximum time weighted average concentration for a moving window</a></p> + <ul> + <li><code><a href="max_twa.html">max_twa</a></code></li> + </ul> + <h2 id="section-predicted-environmental-concentrations-in-soil" class="hasAnchor"><a href="#section-predicted-environmental-concentrations-in-soil" class="anchor"></a>Predicted environmental concentrations in soil</h2> + <p class="section-desc"></p> + + + <p><a href="PEC_soil.html">Calculate predicted environmental concentrations in soil</a></p> + <ul> + <li><code><a href="PEC_soil.html">PEC_soil</a></code></li> + </ul> + + <p><a href="soil_scenario_data_EFSA_2015.html">Properties of the predefined scenarios from the EFSA guidance from 2015</a></p> + <ul> + <li><code><a href="soil_scenario_data_EFSA_2015.html">soil_scenario_data_EFSA_2015</a></code></li> + </ul> + <h2 id="section-predicted-environmental-concentrations-in-surface-water" class="hasAnchor"><a href="#section-predicted-environmental-concentrations-in-surface-water" class="anchor"></a>Predicted environmental concentrations in surface water</h2> + <p class="section-desc"></p> + + + <p><a href="PEC_sw_drift.html">Calculate predicted environmental concentrations in surface water due to drift</a></p> + <ul> + <li><code><a href="PEC_sw_drift.html">PEC_sw_drift</a></code></li> + </ul> + + <p><a href="drift_data_JKI.html">Deposition from spray drift expressed as percent of the applied dose as +</a></p> + <ul> + <li><code><a href="drift_data_JKI.html">drift_data_JKI</a></code></li> + </ul> + + <p><a href="PEC_sw_drainage_UK.html">Calculate initial predicted environmental concentrations in surface water due to drainage using the UK method</a></p> + <ul> + <li><code><a href="PEC_sw_drainage_UK.html">PEC_sw_drainage_UK</a></code></li> + </ul> + + <p><a href="TOXSWA_cwa.html">R6 class for holding TOXSWA cwa concentration data and associated statistics</a></p> + <ul> + <li><code><a href="TOXSWA_cwa.html">TOXSWA_cwa</a></code></li> + </ul> + + <p><a href="read.TOXSWA_cwa.html">Read TOXSWA surface water concentrations</a></p> + <ul> + <li><code><a href="read.TOXSWA_cwa.html">read.TOXSWA_cwa</a></code></li> + </ul> + + <p><a href="plot.TOXSWA_cwa.html">Plot TOXSWA surface water concentrations</a></p> + <ul> + <li><code><a href="plot.TOXSWA_cwa.html">plot.TOXSWA_cwa</a></code></li> + </ul> + <h2 id="section-classifications-and-indicators" class="hasAnchor"><a href="#section-classifications-and-indicators" class="anchor"></a>Classifications and indicators</h2> + <p class="section-desc"><p>Evaluating environmental fate properties</p></p> + + + <p><a href="SSLRC_mobility_classification.html">Determine the SSLRC mobility classification for a chemical substance from its Koc</a></p> + <ul> + <li><code><a href="SSLRC_mobility_classification.html">SSLRC_mobility_classification</a></code></li> + </ul> + + <p><a href="GUS.html">Groundwater ubiquity score based on Gustafson (1989)</a></p> + <ul> + <li><code><a href="GUS.html">GUS</a></code></li><li><code><a href="GUS.html">GUS.numeric</a></code></li><li><code><a href="GUS.html">GUS.chent</a></code></li><li><code><a href="GUS.html">print.GUS_result</a></code></li> + </ul> + + </div> + </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="#section-general-utility-functions">General utility functions</a></li> + <li><a href="#section-predicted-environmental-concentrations-in-soil">Predicted environmental concentrations in soil</a></li> + <li><a href="#section-predicted-environmental-concentrations-in-surface-water">Predicted environmental concentrations in surface water</a></li> + <li><a href="#section-classifications-and-indicators">Classifications and indicators</a></li> + </ul> + </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> |