diff options
Diffstat (limited to 'docs/reference/max_twa_parent.html')
| -rw-r--r-- | docs/reference/max_twa_parent.html | 138 |
1 files changed, 61 insertions, 77 deletions
diff --git a/docs/reference/max_twa_parent.html b/docs/reference/max_twa_parent.html index c560a763..453f801a 100644 --- a/docs/reference/max_twa_parent.html +++ b/docs/reference/max_twa_parent.html @@ -1,85 +1,69 @@ <!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"><meta name="description" content="This function calculates maximum moving window time weighted average +<!-- 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>Function to calculate maximum time weighted average concentrations from kinetic models fitted with mkinfit — max_twa_parent • mkin</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><link href="../deps/font-awesome-6.5.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.5.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Function to calculate maximum time weighted average concentrations from kinetic models fitted with mkinfit — max_twa_parent"><meta name="description" content="This function calculates maximum moving window time weighted average concentrations (TWAs) for kinetic models fitted with mkinfit. Currently, only calculations for the parent are implemented for the SFO, FOMC, DFOP and HS models, using the analytical formulas given in the PEC -soil section of the FOCUS guidance."><title>Function to calculate maximum time weighted average concentrations from -kinetic models fitted with mkinfit — max_twa_parent • mkin</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.2.2/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.2.2/bootstrap.bundle.min.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- bootstrap-toc --><script src="https://cdn.jsdelivr.net/gh/afeld/bootstrap-toc@v1.0.1/dist/bootstrap-toc.min.js" integrity="sha256-4veVQbu7//Lk5TSmc7YV48MxtMy98e26cf5MrgZYnwo=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- search --><script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.js" integrity="sha512-zv6Ywkjyktsohkbp9bb45V6tEMoWhzFzXis+LrMehmJZZSys19Yxf1dopHx7WzIKxr5tK2dVcYmaCk2uqdjF4A==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js" integrity="sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js" integrity="sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww==" crossorigin="anonymous"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Function to calculate maximum time weighted average concentrations from -kinetic models fitted with mkinfit — max_twa_parent"><meta property="og:description" content="This function calculates maximum moving window time weighted average +soil section of the FOCUS guidance."><meta property="og:description" content="This function calculates maximum moving window time weighted average concentrations (TWAs) for kinetic models fitted with mkinfit. Currently, only calculations for the parent are implemented for the SFO, FOMC, DFOP and HS models, using the analytical formulas given in the PEC -soil section of the FOCUS guidance."><!-- 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> +soil section of the FOCUS guidance."></head><body> <a href="#main" class="visually-hidden-focusable">Skip to contents</a> - - <nav class="navbar fixed-top navbar-default navbar-expand-lg bg-light"><div class="container"> - + + <nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="default" aria-label="Site navigation"><div class="container"> + <a class="navbar-brand me-2" href="../index.html">mkin</a> - <small class="nav-text text-default me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Released version">1.2.6</small> + <small class="nav-text text-default me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Released version">1.2.9</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> + <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 dropdown"> - <a href="#" class="nav-link dropdown-toggle" data-bs-toggle="dropdown" role="button" aria-expanded="false" aria-haspopup="true" id="dropdown-articles">Articles</a> - <div class="dropdown-menu" aria-labelledby="dropdown-articles"> - <a class="dropdown-item" href="../articles/mkin.html">Introduction to mkin</a> - <div class="dropdown-divider"></div> - <h6 class="dropdown-header" data-toc-skip>Example evaluations with (generalised) nonlinear least squares</h6> - <a class="dropdown-item" href="../articles/FOCUS_D.html">Example evaluation of FOCUS Example Dataset D</a> - <a class="dropdown-item" href="../articles/FOCUS_L.html">Example evaluation of FOCUS Laboratory Data L1 to L3</a> - <a class="dropdown-item" href="../articles/web_only/FOCUS_Z.html">Example evaluation of FOCUS Example Dataset Z</a> - <div class="dropdown-divider"></div> - <h6 class="dropdown-header" data-toc-skip>Example evaluations with hierarchical models (nonlinear mixed-effects models)</h6> - <a class="dropdown-item" href="../articles/prebuilt/2022_dmta_parent.html">Testing hierarchical parent degradation kinetics with residue data on dimethenamid and dimethenamid-P</a> - <a class="dropdown-item" href="../articles/prebuilt/2022_dmta_pathway.html">Testing hierarchical pathway kinetics with residue data on dimethenamid and dimethenamid-P</a> - <a class="dropdown-item" href="../articles/prebuilt/2023_mesotrione_parent.html">Testing covariate modelling in hierarchical parent degradation kinetics with residue data on mesotrione</a> - <a class="dropdown-item" href="../articles/prebuilt/2022_cyan_pathway.html">Testing hierarchical pathway kinetics with residue data on cyantraniliprole</a> - <a class="dropdown-item" href="../articles/web_only/dimethenamid_2018.html">Comparison of saemix and nlme evaluations of dimethenamid data from 2018</a> - <a class="dropdown-item" href="../articles/web_only/multistart.html">Short demo of the multistart method</a> - <div class="dropdown-divider"></div> - <h6 class="dropdown-header" data-toc-skip>Performance</h6> - <a class="dropdown-item" href="../articles/web_only/compiled_models.html">Performance benefit by using compiled model definitions in mkin</a> - <a class="dropdown-item" href="../articles/web_only/benchmarks.html">Benchmark timings for mkin</a> - <a class="dropdown-item" href="../articles/web_only/saem_benchmarks.html">Benchmark timings for saem.mmkin</a> - <div class="dropdown-divider"></div> - <h6 class="dropdown-header" data-toc-skip>Miscellaneous</h6> - <a class="dropdown-item" href="../articles/twa.html">Calculation of time weighted average concentrations with mkin</a> - <a class="dropdown-item" href="../articles/web_only/NAFTA_examples.html">Example evaluation of NAFTA SOP Attachment examples</a> - </div> -</li> -<li class="nav-item"> - <a class="nav-link" href="../news/index.html">News</a> -</li> - </ul><form class="form-inline my-2 my-lg-0" role="search"> - <input type="search" class="form-control me-sm-2" aria-label="Toggle navigation" name="search-input" data-search-index="../search.json" id="search-input" placeholder="Search for" autocomplete="off"></form> - - <ul class="navbar-nav"><li class="nav-item"> - <a class="external-link nav-link" href="https://github.com/jranke/mkin/" aria-label="github"> - <span class="fab fa fab fa-github fa-lg"></span> - - </a> -</li> + <button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button> + <ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><a class="dropdown-item" href="../articles/mkin.html">Introduction to mkin</a></li> + <li><hr class="dropdown-divider"></li> + <li><h6 class="dropdown-header" data-toc-skip>Example evaluations with (generalised) nonlinear least squares</h6></li> + <li><a class="dropdown-item" href="../articles/FOCUS_D.html">Example evaluation of FOCUS Example Dataset D</a></li> + <li><a class="dropdown-item" href="../articles/FOCUS_L.html">Example evaluation of FOCUS Laboratory Data L1 to L3</a></li> + <li><a class="dropdown-item" href="../articles/web_only/FOCUS_Z.html">Example evaluation of FOCUS Example Dataset Z</a></li> + <li><hr class="dropdown-divider"></li> + <li><h6 class="dropdown-header" data-toc-skip>Example evaluations with hierarchical models (nonlinear mixed-effects models)</h6></li> + <li><a class="dropdown-item" href="../articles/prebuilt/2022_dmta_parent.html">Testing hierarchical parent degradation kinetics with residue data on dimethenamid and dimethenamid-P</a></li> + <li><a class="dropdown-item" href="../articles/prebuilt/2022_dmta_pathway.html">Testing hierarchical pathway kinetics with residue data on dimethenamid and dimethenamid-P</a></li> + <li><a class="dropdown-item" href="../articles/prebuilt/2023_mesotrione_parent.html">Testing covariate modelling in hierarchical parent degradation kinetics with residue data on mesotrione</a></li> + <li><a class="dropdown-item" href="../articles/prebuilt/2022_cyan_pathway.html">Testing hierarchical pathway kinetics with residue data on cyantraniliprole</a></li> + <li><a class="dropdown-item" href="../articles/web_only/dimethenamid_2018.html">Comparison of saemix and nlme evaluations of dimethenamid data from 2018</a></li> + <li><a class="dropdown-item" href="../articles/web_only/multistart.html">Short demo of the multistart method</a></li> + <li><hr class="dropdown-divider"></li> + <li><h6 class="dropdown-header" data-toc-skip>Performance</h6></li> + <li><a class="dropdown-item" href="../articles/web_only/compiled_models.html">Performance benefit by using compiled model definitions in mkin</a></li> + <li><a class="dropdown-item" href="../articles/web_only/benchmarks.html">Benchmark timings for mkin</a></li> + <li><a class="dropdown-item" href="../articles/web_only/saem_benchmarks.html">Benchmark timings for saem.mmkin</a></li> + <li><hr class="dropdown-divider"></li> + <li><h6 class="dropdown-header" data-toc-skip>Miscellaneous</h6></li> + <li><a class="dropdown-item" href="../articles/twa.html">Calculation of time weighted average concentrations with mkin</a></li> + <li><a class="dropdown-item" href="../articles/web_only/NAFTA_examples.html">Example evaluation of NAFTA SOP Attachment examples</a></li> + </ul></li> +<li class="nav-item"><a class="nav-link" href="../coverage/coverage.html">Test coverage</a></li> +<li class="nav-item"><a class="nav-link" href="../news/index.html">News</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/mkin/" 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"> - <img src="" class="logo" alt=""><h1>Function to calculate maximum time weighted average concentrations from -kinetic models fitted with mkinfit</h1> + + <h1>Function to calculate maximum time weighted average concentrations from kinetic models fitted with mkinfit</h1> <small class="dont-index">Source: <a href="https://github.com/jranke/mkin/blob/HEAD/R/max_twa_parent.R" class="external-link"><code>R/max_twa_parent.R</code></a></small> <div class="d-none name"><code>max_twa_parent.Rd</code></div> </div> @@ -107,59 +91,59 @@ soil section of the FOCUS guidance.</p> <div class="section level2"> <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2> - <dl><dt>fit</dt> + + +<dl><dt id="arg-fit">fit<a class="anchor" aria-label="anchor" href="#arg-fit"></a></dt> <dd><p>An object of class <code><a href="mkinfit.html">mkinfit</a></code>.</p></dd> -<dt>windows</dt> +<dt id="arg-windows">windows<a class="anchor" aria-label="anchor" href="#arg-windows"></a></dt> <dd><p>The width of the time windows for which the TWAs should be calculated.</p></dd> -<dt>M0</dt> +<dt id="arg-m-">M0<a class="anchor" aria-label="anchor" href="#arg-m-"></a></dt> <dd><p>The initial concentration for which the maximum time weighted average over the decline curve should be calculated. The default is to use a value of 1, which means that a relative maximum time weighted average factor (f_twa) is calculated.</p></dd> -<dt>k</dt> +<dt id="arg-k">k<a class="anchor" aria-label="anchor" href="#arg-k"></a></dt> <dd><p>The rate constant in the case of SFO kinetics.</p></dd> -<dt>t</dt> +<dt id="arg-t">t<a class="anchor" aria-label="anchor" href="#arg-t"></a></dt> <dd><p>The width of the time window.</p></dd> -<dt>alpha</dt> +<dt id="arg-alpha">alpha<a class="anchor" aria-label="anchor" href="#arg-alpha"></a></dt> <dd><p>Parameter of the FOMC model.</p></dd> -<dt>beta</dt> +<dt id="arg-beta">beta<a class="anchor" aria-label="anchor" href="#arg-beta"></a></dt> <dd><p>Parameter of the FOMC model.</p></dd> -<dt>k1</dt> +<dt id="arg-k-">k1<a class="anchor" aria-label="anchor" href="#arg-k-"></a></dt> <dd><p>The first rate constant of the DFOP or the HS kinetics.</p></dd> -<dt>k2</dt> +<dt id="arg-k-">k2<a class="anchor" aria-label="anchor" href="#arg-k-"></a></dt> <dd><p>The second rate constant of the DFOP or the HS kinetics.</p></dd> -<dt>g</dt> +<dt id="arg-g">g<a class="anchor" aria-label="anchor" href="#arg-g"></a></dt> <dd><p>Parameter of the DFOP model.</p></dd> -<dt>tb</dt> +<dt id="arg-tb">tb<a class="anchor" aria-label="anchor" href="#arg-tb"></a></dt> <dd><p>Parameter of the HS model.</p></dd> </dl></div> <div class="section level2"> <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2> - - -<p>For <code>max_twa_parent</code>, a numeric vector, named using the + <p>For <code>max_twa_parent</code>, a numeric vector, named using the <code>windows</code> argument. For the other functions, a numeric vector of length one (also known as 'a number').</p> </div> @@ -186,23 +170,23 @@ EC Document Reference Sanco/10058/2005 version 2.0, 434 pp, <span class="r-in"><span></span></span> </code></pre></div> </div> - </main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2> + </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></p><p>Developed by Johannes Ranke.</p> + <p>Developed by Johannes Ranke.</p> </div> <div class="pkgdown-footer-right"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> + <p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.1.</p> </div> </footer></div> - - + + </body></html> |