diff options
author | Johannes Ranke <jranke@uni-bremen.de> | 2022-09-28 16:47:48 +0200 |
---|---|---|
committer | Johannes Ranke <jranke@uni-bremen.de> | 2022-09-28 16:47:48 +0200 |
commit | 05df90d8328b804ad1efe92c81e9ace491b386ec (patch) | |
tree | 12afe1af691881ea3fed69d835e2c262acfdf70c /docs/dev/reference/parms.html | |
parent | 3529f5ff498d7d054c7b1911ddfc4b242902b85d (diff) |
Update vignette and static docs
Diffstat (limited to 'docs/dev/reference/parms.html')
-rw-r--r-- | docs/dev/reference/parms.html | 17 |
1 files changed, 14 insertions, 3 deletions
diff --git a/docs/dev/reference/parms.html b/docs/dev/reference/parms.html index ded4567a..949bb2f9 100644 --- a/docs/dev/reference/parms.html +++ b/docs/dev/reference/parms.html @@ -46,12 +46,15 @@ without considering the error structure that was assumed for the fit."><meta nam <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> @@ -80,7 +83,7 @@ without considering the error structure that was assumed for the fit."><meta nam <div class="col-md-9 contents"> <div class="page-header"> <h1>Extract model parameters</h1> - <small class="dont-index">Source: <a href="https://github.com/jranke/mkin/blob/HEAD/R/parms.mkinfit.R" class="external-link"><code>R/parms.mkinfit.R</code></a></small> + <small class="dont-index">Source: <a href="https://github.com/jranke/mkin/blob/HEAD/R/parms.R" class="external-link"><code>R/parms.R</code></a></small> <div class="hidden name"><code>parms.Rd</code></div> </div> @@ -97,7 +100,10 @@ without considering the error structure that was assumed for the fit.</p> <span><span class="fu">parms</span><span class="op">(</span><span class="va">object</span>, transformed <span class="op">=</span> <span class="cn">FALSE</span>, errparms <span class="op">=</span> <span class="cn">TRUE</span>, <span class="va">...</span><span class="op">)</span></span> <span></span> <span><span class="co"># S3 method for mmkin</span></span> -<span><span class="fu">parms</span><span class="op">(</span><span class="va">object</span>, transformed <span class="op">=</span> <span class="cn">FALSE</span>, errparms <span class="op">=</span> <span class="cn">TRUE</span>, <span class="va">...</span><span class="op">)</span></span></code></pre></div> +<span><span class="fu">parms</span><span class="op">(</span><span class="va">object</span>, transformed <span class="op">=</span> <span class="cn">FALSE</span>, errparms <span class="op">=</span> <span class="cn">TRUE</span>, <span class="va">...</span><span class="op">)</span></span> +<span></span> +<span><span class="co"># S3 method for multistart</span></span> +<span><span class="fu">parms</span><span class="op">(</span><span class="va">object</span>, exclude_failed <span class="op">=</span> <span class="cn">TRUE</span>, <span class="va">...</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> @@ -119,6 +125,11 @@ during the optimisation?</p></dd> <dd><p>Should the error model parameters be returned in addition to the degradation parameters?</p></dd> + +<dt>exclude_failed</dt> +<dd><p>For <a href="multistart.html">multistart</a> objects, should rows for failed fits +be removed from the returned parameter matrix?</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> |