aboutsummaryrefslogblamecommitdiff
path: root/docs/reference/index.html
blob: 9973635920efb20d9d133c4b2d83191f65f15495 (plain) (tree)


























                                                                                                                                                                                                                      
                                                                                                  




                                                                               

 


































                                                                                                         



                                         


                          



















































































































                                                                                                                                                                                                                                                                 
                                                                     








































                                                                                                                                                                                      







                                                                                                                                   
                                                                                                                                                 



















                                                                                                                                                     
<!-- 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://mathjax.rstudio.com/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>
        Reference
        <small>version&nbsp;0.4-3</small>
      </h1>
    </div>

    <div class="contents">
      <table class="ref-index">

      <colgroup>
        <col class="alias" />
        <col class="title" />
      </colgroup>

      <tbody>
        <tr>
          <th colspan="2">
            <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>
          </th>
        </tr>
        <tr>
          <!--  -->
          <td>
            <p><code><a href="geomean.html">geomean</a></code> </p>
          </td>
          <td><p>Calculate the geometric mean</p></td>
        </tr><tr>
          <!--  -->
          <td>
            <p><code><a href="one_box.html">one_box</a></code> </p>
          </td>
          <td><p>Create a time series of decline data</p></td>
        </tr><tr>
          <!--  -->
          <td>
            <p><code><a href="plot.one_box.html">plot</a></code> </p>
          </td>
          <td><p>Plot time series of decline data</p></td>
        </tr><tr>
          <!--  -->
          <td>
            <p><code><a href="sawtooth.html">sawtooth</a></code> </p>
          </td>
          <td><p>Create decline time series for multiple applications</p></td>
        </tr><tr>
          <!--  -->
          <td>
            <p><code><a href="twa.html">twa</a></code> </p>
          </td>
          <td><p>Calculate a time weighted average concentration</p></td>
        </tr><tr>
          <!--  -->
          <td>
            <p><code><a href="max_twa.html">max_twa</a></code> </p>
          </td>
          <td><p>The maximum time weighted average concentration for a moving window</p></td>
        </tr>
      </tbody><tbody>
        <tr>
          <th colspan="2">
            <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>
          </th>
        </tr>
        <tr>
          <!--  -->
          <td>
            <p><code><a href="PEC_soil.html">PEC_soil</a></code> </p>
          </td>
          <td><p>Calculate predicted environmental concentrations in soil</p></td>
        </tr><tr>
          <!--  -->
          <td>
            <p><code><a href="soil_scenario_data_EFSA_2015.html">soil_scenario_data_EFSA_2015</a></code> </p>
          </td>
          <td><p>Properties of the predefined scenarios from the EFSA guidance from 2015</p></td>
        </tr>
      </tbody><tbody>
        <tr>
          <th colspan="2">
            <h2 id="section-predicted-environmental-concentrations-in-groundwater" class="hasAnchor"><a href="#section-predicted-environmental-concentrations-in-groundwater" class="anchor"></a>Predicted environmental concentrations in groundwater</h2>
            <p class="section-desc"></p>
          </th>
        </tr>
        <tr>
          <!--  -->
          <td>
            <p><code><a href="PELMO_runs.html">PELMO_runs</a></code> <code><a href="PELMO_runs.html">run_PELMO</a></code> <code><a href="PELMO_runs.html">evaluate_PELMO</a></code> </p>
          </td>
          <td><p>Set up runs for FOCUS PELMO</p></td>
        </tr>
      </tbody><tbody>
        <tr>
          <th colspan="2">
            <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>
          </th>
        </tr>
        <tr>
          <!--  -->
          <td>
            <p><code><a href="PEC_sw_drift.html">PEC_sw_drift</a></code> </p>
          </td>
          <td><p>Calculate predicted environmental concentrations in surface water due to drift</p></td>
        </tr><tr>
          <!--  -->
          <td>
            <p><code><a href="drift_data_JKI.html">drift_data_JKI</a></code> </p>
          </td>
          <td><p>Deposition from spray drift expressed as percent of the applied dose as
published by the JKI</p></td>
        </tr><tr>
          <!--  -->
          <td>
            <p><code><a href="PEC_sw_drainage_UK.html">PEC_sw_drainage_UK</a></code> </p>
          </td>
          <td><p>Calculate initial predicted environmental concentrations in surface water due to drainage using the UK method</p></td>
        </tr><tr>
          <!--  -->
          <td>
            <p><code><a href="PEC_sw_focus.html">PEC_sw_focus</a></code> </p>
          </td>
          <td><p>Calculate PEC surface water at FOCUS Step 1</p></td>
        </tr><tr>
          <!--  -->
          <td>
            <p><code><a href="TOXSWA_cwa.html">TOXSWA_cwa</a></code> </p>
          </td>
          <td><p>R6 class for holding TOXSWA cwa concentration data and associated statistics</p></td>
        </tr><tr>
          <!--  -->
          <td>
            <p><code><a href="read.TOXSWA_cwa.html">read.TOXSWA_cwa</a></code> </p>
          </td>
          <td><p>Read TOXSWA surface water concentrations</p></td>
        </tr><tr>
          <!--  -->
          <td>
            <p><code><a href="plot.TOXSWA_cwa.html">plot</a></code> </p>
          </td>
          <td><p>Plot TOXSWA surface water concentrations</p></td>
        </tr>
      </tbody><tbody>
        <tr>
          <th colspan="2">
            <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>
          </th>
        </tr>
        <tr>
          <!--  -->
          <td>
            <p><code><a href="SSLRC_mobility_classification.html">SSLRC_mobility_classification</a></code> </p>
          </td>
          <td><p>Determine the SSLRC mobility classification for a chemical substance from its Koc</p></td>
        </tr><tr>
          <!--  -->
          <td>
            <p><code><a href="GUS.html">GUS</a></code> <code><a href="GUS.html">print</a></code> </p>
          </td>
          <td><p>Groundwater ubiquity score based on Gustafson (1989)</p></td>
        </tr>
      </tbody>
      </table>
    </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-groundwater">Predicted environmental concentrations in groundwater</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>

Contact - Imprint