aboutsummaryrefslogtreecommitdiff
path: root/docs/dev/reference/summary.saem.mmkin.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/dev/reference/summary.saem.mmkin.html')
-rw-r--r--docs/dev/reference/summary.saem.mmkin.html29
1 files changed, 24 insertions, 5 deletions
diff --git a/docs/dev/reference/summary.saem.mmkin.html b/docs/dev/reference/summary.saem.mmkin.html
index aa573589..e434ad8d 100644
--- a/docs/dev/reference/summary.saem.mmkin.html
+++ b/docs/dev/reference/summary.saem.mmkin.html
@@ -119,7 +119,15 @@ endpoints such as formation fractions and DT50 values. Optionally
<div id="ref-usage">
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="co"># S3 method for saem.mmkin</span></span>
-<span><span class="fu"><a href="https://rdrr.io/pkg/saemix/man/summary-methods.html" class="external-link">summary</a></span><span class="op">(</span><span class="va">object</span>, data <span class="op">=</span> <span class="cn">FALSE</span>, verbose <span class="op">=</span> <span class="cn">FALSE</span>, distimes <span class="op">=</span> <span class="cn">TRUE</span>, <span class="va">...</span><span class="op">)</span></span>
+<span><span class="fu"><a href="https://rdrr.io/pkg/saemix/man/summary-methods.html" class="external-link">summary</a></span><span class="op">(</span></span>
+<span> <span class="va">object</span>,</span>
+<span> data <span class="op">=</span> <span class="cn">FALSE</span>,</span>
+<span> verbose <span class="op">=</span> <span class="cn">FALSE</span>,</span>
+<span> covariates <span class="op">=</span> <span class="cn">NULL</span>,</span>
+<span> covariate_quantile <span class="op">=</span> <span class="fl">0.5</span>,</span>
+<span> distimes <span class="op">=</span> <span class="cn">TRUE</span>,</span>
+<span> <span class="va">...</span></span>
+<span><span class="op">)</span></span>
<span></span>
<span><span class="co"># S3 method for summary.saem.mmkin</span></span>
<span><span class="fu"><a href="https://rdrr.io/r/base/print.html" class="external-link">print</a></span><span class="op">(</span><span class="va">x</span>, digits <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/Extremes.html" class="external-link">max</a></span><span class="op">(</span><span class="fl">3</span>, <span class="fu"><a href="https://rdrr.io/r/base/options.html" class="external-link">getOption</a></span><span class="op">(</span><span class="st">"digits"</span><span class="op">)</span> <span class="op">-</span> <span class="fl">3</span><span class="op">)</span>, verbose <span class="op">=</span> <span class="va">x</span><span class="op">$</span><span class="va">verbose</span>, <span class="va">...</span><span class="op">)</span></span></code></pre></div>
@@ -140,6 +148,17 @@ the summary.</p></dd>
<dd><p>Should the summary be verbose?</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>
+
+
<dt>distimes</dt>
<dd><p>logical, indicating whether DT50 and DT90 values should be
included.</p></dd>
@@ -312,9 +331,9 @@ saemix authors for the parts inherited from saemix.</p>
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/pkg/saemix/man/summary-methods.html" class="external-link">summary</a></span><span class="op">(</span><span class="va">f_saem_dfop_sfo_2</span>, data <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> saemix version used for fitting: 3.2 </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> mkin version used for pre-fitting: 1.2.3 </span>
-<span class="r-out co"><span class="r-pr">#&gt;</span> R version used for fitting: 4.2.2 </span>
-<span class="r-out co"><span class="r-pr">#&gt;</span> Date of fit: Fri Feb 17 22:24:21 2023 </span>
-<span class="r-out co"><span class="r-pr">#&gt;</span> Date of summary: Fri Feb 17 22:24:21 2023 </span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> R version used for fitting: 4.2.3 </span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> Date of fit: Sun Apr 16 08:34:58 2023 </span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> Date of summary: Sun Apr 16 08:34:58 2023 </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Equations:</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> d_parent/dt = - ((k1 * g * exp(-k1 * time) + k2 * (1 - g) * exp(-k2 *</span>
@@ -329,7 +348,7 @@ saemix authors for the parts inherited from saemix.</p>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Model predictions using solution type analytical </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
-<span class="r-out co"><span class="r-pr">#&gt;</span> Fitted in 9.426 s</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> Fitted in 9.384 s</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Using 300, 100 iterations and 10 chains</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Variance model: Two-component variance function </span>

Contact - Imprint