path: root/docs/reference/index.html


                                                  
<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
<html lang="en">
  <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://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
<!-- Bootstrap -->

<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha256-916EbMg70RQy9LHiGkXzG8hSg9EdNy97GazNG/aiY1w=" crossorigin="anonymous" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script>

<!-- Font Awesome icons -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css" integrity="sha256-eZrrJcwDc/3uDhsdt61sL2oOBY362qM3lon1gyExkL0=" crossorigin="anonymous" />

<!-- clipboard.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.4/clipboard.min.js" integrity="sha256-FiZwavyI2V6+EXO1U+xzLG3IKldpiTFf3153ea9zikQ=" crossorigin="anonymous"></script>

<!-- sticky kit -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/sticky-kit/1.1.3/sticky-kit.min.js" integrity="sha256-c4Rlo1ZozqTPE2RLuvbusY3+SU1pQaJC0TjuhygMipw=" crossorigin="anonymous"></script>

<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
<script src="../pkgdown.js"></script>


<meta property="og:title" content="Function reference" />


<!-- mathjax -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></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" aria-expanded="false">
        <span class="sr-only">Toggle navigation</span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
      </button>
      <span class="navbar-brand">
        <a class="navbar-link" href="../index.html">pfm</a>
        <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.5.3</span>
      </span>
    </div>

    <div id="navbar" class="navbar-collapse collapse">
      <ul class="nav navbar-nav">
        <li>
  <a href="../index.html">
    <span class="fa fa-home fa-lg"></span>
     
  </a>
</li>
<li>
  <a href="../reference/index.html">Reference</a>
</li>
      </ul>
      
      <ul class="nav navbar-nav navbar-right">
        <li>
  <a href="https://github.com/jranke/pfm">
    <span class="fa fa-github fa-lg"></span>
     
  </a>
</li>
      </ul>
      
    </div><!--/.nav-collapse -->
  </div><!--/.container -->
</div><!--/.navbar -->

      
      </header>

<div class="row">
  <div class="contents col-md-9">
    <div class="page-header">
      <h1>Reference</h1>
    </div>

    <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(<i>&lt;one_box&gt;</i>)</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><tr>
        
        <td>
          <p><code><a href="pfm_degradation.html">pfm_degradation()</a></code> </p>
        </td>
        <td><p>Calculate a time course of relative concentrations based on an mkinmod model</p></td>
      </tr><tr>
        
        <td>
          <p><code><a href="SFO_actual_twa.html">SFO_actual_twa()</a></code> </p>
        </td>
        <td><p>Actual and maximum moving window time average concentrations for SFO kinetics</p></td>
      </tr><tr>
        
        <td>
          <p><code><a href="FOMC_actual_twa.html">FOMC_actual_twa()</a></code> </p>
        </td>
        <td><p>Actual and maximum moving window time average concentrations for FOMC kinetics</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="PEC_soil_mets.html">PEC_soil_mets()</a></code> </p>
        </td>
        <td><p>Calculate initial and accumulation PEC soil for a set of metabolites</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><tr>
        
        <td>
          <p><code><a href="soil_scenario_data_EFSA_2017.html">soil_scenario_data_EFSA_2017</a></code> </p>
        </td>
        <td><p>Properties of the predefined scenarios from the EFSA guidance from 2017</p></td>
      </tr><tr>
        
        <td>
          <p><code><a href="PEC_FOMC_accu_rel.html">PEC_FOMC_accu_rel()</a></code> </p>
        </td>
        <td><p>Get the relative accumulation of an FOMC model over multiples of an interval</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="FOCUS_GW_scenarios_2012.html">FOCUS_GW_scenarios_2012</a></code> </p>
        </td>
        <td><p>A very small subset of the FOCUS Groundwater scenario definitions</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_sed.html">PEC_sw_sed()</a></code> </p>
        </td>
        <td><p>Calculate predicted environmental concentrations in sediment from surface
water concentrations</p></td>
      </tr><tr>
        
        <td>
          <p><code><a href="chent_focus_sw.html">chent_focus_sw()</a></code> </p>
        </td>
        <td><p>Create a chemical compound object for FOCUS Step 1 calculations</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="FOCUS_Step_12_scenarios.html">FOCUS_Step_12_scenarios</a></code> </p>
        </td>
        <td><p>Step 1/2 scenario data as distributed with the FOCUS Step 1/2 calculator</p></td>
      </tr><tr>
        
        <td>
          <p><code><a href="perc_runoff_exposit.html">perc_runoff_exposit</a></code> </p>
        </td>
        <td><p>Runoff loss percentages as used in Exposit 3</p></td>
      </tr><tr>
        
        <td>
          <p><code><a href="perc_runoff_reduction_exposit.html">perc_runoff_reduction_exposit</a></code> </p>
        </td>
        <td><p>Runoff reduction percentages as used in Exposit</p></td>
      </tr><tr>
        
        <td>
          <p><code><a href="PEC_sw_exposit_runoff.html">PEC_sw_exposit_runoff()</a></code> </p>
        </td>
        <td><p>Calculate PEC surface water due to runoff and erosion as in Exposit 3</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 water 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(<i>&lt;TOXSWA_cwa&gt;</i>)</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(<i>&lt;GUS_result&gt;</i>)</a></code> </p>
        </td>
        <td><p>Groundwater ubiquity score based on Gustafson (1989)</p></td>
      </tr>
    </tbody><tbody>
      <tr>
        <th colspan="2">
          <h2 id="section-utilities" class="hasAnchor"><a href="#section-utilities" class="anchor"></a>Utilities</h2>
          <p class="section-desc"></p>
        </th>
      </tr>
      <tr>
        
        <td>
          <p><code><a href="get_vertex.html">get_vertex()</a></code> </p>
        </td>
        <td><p>Fit a parabola through three points</p></td>
      </tr>
    </tbody>
    </table>
  </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>
      <li><a href="#section-utilities">Utilities</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="https://pkgdown.r-lib.org/">pkgdown</a> 1.3.0.</p>
</div>
      </footer>
   </div>

  
  </body>
</html>