aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/endpoints.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/reference/endpoints.html')
-rw-r--r--docs/reference/endpoints.html48
1 files changed, 38 insertions, 10 deletions
diff --git a/docs/reference/endpoints.html b/docs/reference/endpoints.html
index 1f49092e..6029a656 100644
--- a/docs/reference/endpoints.html
+++ b/docs/reference/endpoints.html
@@ -23,13 +23,13 @@ advantage that the SFORB model can also be used for metabolites."><!-- mathjax -
</button>
<span class="navbar-brand">
<a class="navbar-link" href="../index.html">mkin</a>
- <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">1.2.0</span>
+ <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">1.2.3</span>
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav"><li>
- <a href="../reference/index.html">Functions and data</a>
+ <a href="../reference/index.html">Reference</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false">
@@ -40,6 +40,8 @@ advantage that the SFORB model can also be used for metabolites."><!-- mathjax -
<ul class="dropdown-menu" role="menu"><li>
<a href="../articles/mkin.html">Introduction to mkin</a>
</li>
+ <li class="divider">
+ <li class="dropdown-header">Example evaluations with (generalised) nonlinear least squares</li>
<li>
<a href="../articles/FOCUS_D.html">Example evaluation of FOCUS Example Dataset D</a>
</li>
@@ -47,22 +49,29 @@ advantage that the SFORB model can also be used for metabolites."><!-- mathjax -
<a href="../articles/FOCUS_L.html">Example evaluation of FOCUS Laboratory Data L1 to L3</a>
</li>
<li>
- <a href="../articles/web_only/dimethenamid_2018.html">Example evaluations of dimethenamid data from 2018 with nonlinear mixed-effects models</a>
+ <a href="../articles/web_only/FOCUS_Z.html">Example evaluation of FOCUS Example Dataset Z</a>
</li>
+ <li class="divider">
+ <li class="dropdown-header">Example evaluations with hierarchical models (nonlinear mixed-effects models)</li>
<li>
- <a href="../articles/web_only/multistart.html">Short demo of the multistart method</a>
+ <a href="../articles/prebuilt/2022_dmta_parent.html">Testing hierarchical parent degradation kinetics with residue data on dimethenamid and dimethenamid-P</a>
</li>
<li>
- <a href="../articles/web_only/compiled_models.html">Performance benefit by using compiled model definitions in mkin</a>
+ <a href="../articles/prebuilt/2022_dmta_pathway.html">Testing hierarchical pathway kinetics with residue data on dimethenamid and dimethenamid-P</a>
</li>
<li>
- <a href="../articles/web_only/FOCUS_Z.html">Example evaluation of FOCUS Example Dataset Z</a>
+ <a href="../articles/prebuilt/2022_cyan_pathway.html">Testing hierarchical pathway kinetics with residue data on cyantraniliprole</a>
</li>
<li>
- <a href="../articles/twa.html">Calculation of time weighted average concentrations with mkin</a>
+ <a href="../articles/web_only/dimethenamid_2018.html">Comparison of saemix and nlme evaluations of dimethenamid data from 2018</a>
</li>
<li>
- <a href="../articles/web_only/NAFTA_examples.html">Example evaluation of NAFTA SOP Attachment examples</a>
+ <a href="../articles/web_only/multistart.html">Short demo of the multistart method</a>
+ </li>
+ <li class="divider">
+ <li class="dropdown-header">Performance</li>
+ <li>
+ <a href="../articles/web_only/compiled_models.html">Performance benefit by using compiled model definitions in mkin</a>
</li>
<li>
<a href="../articles/web_only/benchmarks.html">Benchmark timings for mkin</a>
@@ -70,6 +79,14 @@ advantage that the SFORB model can also be used for metabolites."><!-- mathjax -
<li>
<a href="../articles/web_only/saem_benchmarks.html">Benchmark timings for saem.mmkin</a>
</li>
+ <li class="divider">
+ <li class="dropdown-header">Miscellaneous</li>
+ <li>
+ <a href="../articles/twa.html">Calculation of time weighted average concentrations with mkin</a>
+ </li>
+ <li>
+ <a href="../articles/web_only/NAFTA_examples.html">Example evaluation of NAFTA SOP Attachment examples</a>
+ </li>
</ul></li>
<li>
<a href="../news/index.html">News</a>
@@ -104,7 +121,7 @@ advantage that the SFORB model can also be used for metabolites.</p>
</div>
<div id="ref-usage">
- <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">endpoints</span><span class="op">(</span><span class="va">fit</span><span class="op">)</span></span></code></pre></div>
+ <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">endpoints</span><span class="op">(</span><span class="va">fit</span>, covariates <span class="op">=</span> <span class="cn">NULL</span>, covariate_quantile <span class="op">=</span> <span class="fl">0.5</span><span class="op">)</span></span></code></pre></div>
</div>
<div id="arguments">
@@ -115,6 +132,17 @@ another object that has list components mkinmod containing an <a href="mkinmod.h
degradation model, and two numeric vectors, bparms.optim and bparms.fixed,
that contain parameter values for that model.</p></dd>
+
+<dt>covariates</dt>
+<dd><p>Numeric vector with covariate values for all variables in
+any covariate models in the object. If given, it overrides 'covariate_quantile'.</p></dd>
+
+
+<dt>covariate_quantile</dt>
+<dd><p>This argument only has an effect if the fitted
+object has covariate models. If so, the default is to show endpoints
+for the median of the covariate values (50th percentile).</p></dd>
+
</dl></div>
<div id="value">
<h2>Value</h2>
@@ -186,7 +214,7 @@ HS and DFOP, as well as from Eigenvalues b1 and b2 of any SFORB models</p>
</div>
<div class="pkgdown">
- <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.6.</p>
+ <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p>
</div>
</footer></div>

Contact - Imprint