aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/mean_degparms.html
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2022-11-17 14:54:20 +0100
committerJohannes Ranke <jranke@uni-bremen.de>2022-11-17 14:56:25 +0100
commite5d1df9a9b1f0951d7dfbaf24eee4294470b73e2 (patch)
tree18740ef050a68d1a6fe91f1bd2fdfdd97ac6448b /docs/reference/mean_degparms.html
parent90354f5cd9e095f9ef98424689a2716770b248d4 (diff)
Complete update of online docs for v1.2.0
Diffstat (limited to 'docs/reference/mean_degparms.html')
-rw-r--r--docs/reference/mean_degparms.html41
1 files changed, 29 insertions, 12 deletions
diff --git a/docs/reference/mean_degparms.html b/docs/reference/mean_degparms.html
index bea9f2d8..dedb8660 100644
--- a/docs/reference/mean_degparms.html
+++ b/docs/reference/mean_degparms.html
@@ -17,7 +17,7 @@
</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.1.0</span>
+ <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">1.2.0</span>
</span>
</div>
@@ -44,19 +44,25 @@
<a href="../articles/web_only/dimethenamid_2018.html">Example evaluations of dimethenamid data from 2018 with nonlinear mixed-effects models</a>
</li>
<li>
- <a href="../articles/web_only/FOCUS_Z.html">Example evaluation of FOCUS Example Dataset Z</a>
+ <a href="../articles/web_only/multistart.html">Short demo of the multistart method</a>
</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/FOCUS_Z.html">Example evaluation of FOCUS Example Dataset Z</a>
+ </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>
<li>
- <a href="../articles/web_only/benchmarks.html">Some benchmark timings</a>
+ <a href="../articles/web_only/benchmarks.html">Benchmark timings for mkin</a>
+ </li>
+ <li>
+ <a href="../articles/web_only/saem_benchmarks.html">Benchmark timings for saem.mmkin</a>
</li>
</ul></li>
<li>
@@ -87,36 +93,47 @@
</div>
<div id="ref-usage">
- <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">mean_degparms</span><span class="op">(</span>
- <span class="va">object</span>,
- random <span class="op">=</span> <span class="cn">FALSE</span>,
- test_log_parms <span class="op">=</span> <span class="cn">FALSE</span>,
- conf.level <span class="op">=</span> <span class="fl">0.6</span>,
- default_log_parms <span class="op">=</span> <span class="cn">NA</span>
-<span class="op">)</span></code></pre></div>
+ <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">mean_degparms</span><span class="op">(</span></span>
+<span> <span class="va">object</span>,</span>
+<span> random <span class="op">=</span> <span class="cn">FALSE</span>,</span>
+<span> test_log_parms <span class="op">=</span> <span class="cn">FALSE</span>,</span>
+<span> conf.level <span class="op">=</span> <span class="fl">0.6</span>,</span>
+<span> default_log_parms <span class="op">=</span> <span class="cn">NA</span></span>
+<span><span class="op">)</span></span></code></pre></div>
</div>
<div id="arguments">
<h2>Arguments</h2>
<dl><dt>object</dt>
<dd><p>An mmkin row object containing several fits of the same model to different datasets</p></dd>
+
+
<dt>random</dt>
<dd><p>Should a list with fixed and random effects be returned?</p></dd>
+
+
<dt>test_log_parms</dt>
<dd><p>If TRUE, log parameters are only considered in
the mean calculations if their untransformed counterparts (most likely
rate constants) pass the t-test for significant difference from zero.</p></dd>
+
+
<dt>conf.level</dt>
<dd><p>Possibility to adjust the required confidence level
for parameter that are tested if requested by 'test_log_parms'.</p></dd>
+
+
<dt>default_log_parms</dt>
<dd><p>If set to a numeric value, this is used
as a default value for the tested log parameters that failed the
t-test.</p></dd>
+
</dl></div>
<div id="value">
<h2>Value</h2>
- <p>If random is FALSE (default), a named vector containing mean values
+
+
+<p>If random is FALSE (default), a named vector containing mean values
of the fitted degradation model parameters. If random is TRUE, a list with
fixed and random effects, in the format required by the start argument of
nlme for the case of a single grouping variable ds.</p>
@@ -134,7 +151,7 @@ nlme for the case of a single grouping variable ds.</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.3.</p>
+ <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.6.</p>
</div>
</footer></div>

Contact - Imprint