diff options
| author | Johannes Ranke <jranke@uni-bremen.de> | 2023-02-13 05:19:08 +0100 |
|---|---|---|
| committer | Johannes Ranke <jranke@uni-bremen.de> | 2023-02-13 05:19:08 +0100 |
| commit | 8d1a84ac2190538ed3bac53a303064e281595868 (patch) | |
| tree | acb894d85ab7ec87c4911c355a5264a77e08e34b /docs/dev/reference/Extract.mmkin.html | |
| parent | 51d63256a7b3020ee11931d61b4db97b9ded02c0 (diff) | |
| parent | 4200e566ad2600f56bc3987669aeab88582139eb (diff) | |
Merge branch 'main' into custom_lsoda_call
Diffstat (limited to 'docs/dev/reference/Extract.mmkin.html')
| -rw-r--r-- | docs/dev/reference/Extract.mmkin.html | 304 |
1 files changed, 127 insertions, 177 deletions
diff --git a/docs/dev/reference/Extract.mmkin.html b/docs/dev/reference/Extract.mmkin.html index 8381337a..cd863616 100644 --- a/docs/dev/reference/Extract.mmkin.html +++ b/docs/dev/reference/Extract.mmkin.html @@ -1,67 +1,12 @@ -<!-- Generated by pkgdown: do not edit by hand --> <!DOCTYPE html> -<html lang="en"> - <head> - <meta charset="utf-8"> -<meta http-equiv="X-UA-Compatible" content="IE=edge"> -<meta name="viewport" content="width=device-width, initial-scale=1.0"> - -<title>Subsetting method for mmkin objects — [.mmkin • mkin</title> - - -<!-- jquery --> -<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script> -<!-- Bootstrap --> - -<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous" /> - -<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script> - -<!-- bootstrap-toc --> -<link rel="stylesheet" href="../bootstrap-toc.css"> -<script src="../bootstrap-toc.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" /> - -<!-- 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> - -<!-- 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> - -<!-- pkgdown --> -<link href="../pkgdown.css" rel="stylesheet"> -<script src="../pkgdown.js"></script> - - - - -<meta property="og:title" content="Subsetting method for mmkin objects — [.mmkin" /> -<meta property="og:description" content="Subsetting method for mmkin objects" /> - - -<meta name="robots" content="noindex"> - -<!-- 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]> +<!-- 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.0"><title>Subsetting method for mmkin objects — [.mmkin • mkin</title><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous"><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css"><script src="../bootstrap-toc.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"><!-- 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><!-- 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><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"><script src="../pkgdown.js"></script><meta property="og:title" content="Subsetting method for mmkin objects — [.mmkin"><meta property="og:description" content="Subsetting method for mmkin objects"><meta name="robots" content="noindex"><!-- 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]--> +<![endif]--></head><body data-spy="scroll" data-target="#toc"> + - - - </head> - - <body data-spy="scroll" data-target="#toc"> <div class="container template-reference-topic"> - <header> - <div class="navbar navbar-default navbar-fixed-top" role="navigation"> + <header><div class="navbar navbar-default navbar-fixed-top" role="navigation"> <div class="container"> <div class="navbar-header"> <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false"> @@ -72,23 +17,21 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">mkin</a> - <span class="version label label-info" data-toggle="tooltip" data-placement="bottom" title="In-development version">1.0.3.9000</span> + <span class="version label label-info" data-toggle="tooltip" data-placement="bottom" title="In-development version">1.2.2</span> </span> </div> <div id="navbar" class="navbar-collapse collapse"> - <ul class="nav navbar-nav"> - <li> + <ul class="nav navbar-nav"><li> <a href="../reference/index.html">Functions and data</a> </li> <li class="dropdown"> - <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false"> Articles <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"> - <li> + <ul class="dropdown-menu" role="menu"><li> <a href="../articles/mkin.html">Introduction to mkin</a> </li> <li> @@ -98,48 +41,50 @@ <a href="../articles/FOCUS_L.html">Example evaluation of FOCUS Laboratory Data L1 to L3</a> </li> <li> - <a href="../articles/web_only/FOCUS_Z.html">Example evaluation of FOCUS Example Dataset Z</a> + <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/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> - </ul> -</li> + <li> + <a href="../articles/web_only/saem_benchmarks.html">Benchmark timings for saem.mmkin</a> + </li> + </ul></li> <li> <a href="../news/index.html">News</a> </li> - </ul> - <ul class="nav navbar-nav navbar-right"> - <li> - <a href="https://github.com/jranke/mkin/"> + </ul><ul class="nav navbar-nav navbar-right"><li> + <a href="https://github.com/jranke/mkin/" class="external-link"> <span class="fab fa-github fa-lg"></span> </a> </li> - </ul> - - </div><!--/.nav-collapse --> + </ul></div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> - </header> - -<div class="row"> + </header><div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Subsetting method for mmkin objects</h1> - <small class="dont-index">Source: <a href='https://github.com/jranke/mkin/blob/master/R/mmkin.R'><code>R/mmkin.R</code></a></small> + <small class="dont-index">Source: <a href="https://github.com/jranke/mkin/blob/HEAD/R/mmkin.R" class="external-link"><code>R/mmkin.R</code></a></small> <div class="hidden name"><code>Extract.mmkin.Rd</code></div> </div> @@ -147,122 +92,127 @@ <p>Subsetting method for mmkin objects</p> </div> - <pre class="usage"># S3 method for mmkin -[(x, i, j, ..., drop = FALSE)</pre> + <div id="ref-usage"> + <div class="sourceCode"><pre><code># S3 method for mmkin +[(x, i, j, ..., drop = FALSE)</code></pre></div> + </div> + + <div id="arguments"> + <h2>Arguments</h2> + <dl><dt>x</dt> +<dd><p>An <code><a href="mmkin.html">mmkin</a> object</code></p></dd> - <h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2> - <table class="ref-arguments"> - <colgroup><col class="name" /><col class="desc" /></colgroup> - <tr> - <th>x</th> - <td><p>An <code><a href='mmkin.html'>mmkin</a> object</code></p></td> - </tr> - <tr> - <th>i</th> - <td><p>Row index selecting the fits for specific models</p></td> - </tr> - <tr> - <th>j</th> - <td><p>Column index selecting the fits to specific datasets</p></td> - </tr> - <tr> - <th>...</th> - <td><p>Not used, only there to satisfy the generic method definition</p></td> - </tr> - <tr> - <th>drop</th> - <td><p>If FALSE, the method always returns an mmkin object, otherwise -either a list of mkinfit objects or a single mkinfit object.</p></td> - </tr> - </table> - <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2> +<dt>i</dt> +<dd><p>Row index selecting the fits for specific models</p></dd> - <p>An object of class <code><a href='mmkin.html'>mmkin</a></code>.</p> - <h2 class="hasAnchor" id="author"><a class="anchor" href="#author"></a>Author</h2> +<dt>j</dt> +<dd><p>Column index selecting the fits to specific datasets</p></dd> + + +<dt>...</dt> +<dd><p>Not used, only there to satisfy the generic method definition</p></dd> + + +<dt>drop</dt> +<dd><p>If FALSE, the method always returns an mmkin object, otherwise +either a list of mkinfit objects or a single mkinfit object.</p></dd> + +</dl></div> + <div id="value"> + <h2>Value</h2> + + +<p>An object of class <code><a href="mmkin.html">mmkin</a></code>.</p> + </div> + <div id="author"> + <h2>Author</h2> <p>Johannes Ranke</p> + </div> - <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2> - <pre class="examples"><div class='input'> - <span class='co'># Only use one core, to pass R CMD check --as-cran</span> - <span class='va'>fits</span> <span class='op'><-</span> <span class='fu'><a href='mmkin.html'>mmkin</a></span><span class='op'>(</span><span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span><span class='op'>(</span><span class='st'>"SFO"</span>, <span class='st'>"FOMC"</span><span class='op'>)</span>, <span class='fu'><a href='https://rdrr.io/r/base/list.html'>list</a></span><span class='op'>(</span>B <span class='op'>=</span> <span class='va'>FOCUS_2006_B</span>, C <span class='op'>=</span> <span class='va'>FOCUS_2006_C</span><span class='op'>)</span>, - cores <span class='op'>=</span> <span class='fl'>1</span>, quiet <span class='op'>=</span> <span class='cn'>TRUE</span><span class='op'>)</span> - <span class='va'>fits</span><span class='op'>[</span><span class='st'>"FOMC"</span>, <span class='op'>]</span> -</div><div class='output co'>#> <mmkin> object -#> Status of individual fits: -#> -#> dataset -#> model B C -#> FOMC OK OK -#> -#> OK: No warnings</div><div class='input'> <span class='va'>fits</span><span class='op'>[</span>, <span class='st'>"B"</span><span class='op'>]</span> -</div><div class='output co'>#> <mmkin> object -#> Status of individual fits: -#> -#> dataset -#> model B -#> SFO OK -#> FOMC OK -#> -#> OK: No warnings</div><div class='input'> <span class='va'>fits</span><span class='op'>[</span><span class='st'>"SFO"</span>, <span class='st'>"B"</span><span class='op'>]</span> -</div><div class='output co'>#> <mmkin> object -#> Status of individual fits: -#> -#> dataset -#> model B -#> SFO OK -#> -#> OK: No warnings</div><div class='input'> - <span class='fu'><a href='https://rdrr.io/r/utils/head.html'>head</a></span><span class='op'>(</span> - <span class='co'># This extracts an mkinfit object with lots of components</span> - <span class='va'>fits</span><span class='op'>[[</span><span class='st'>"FOMC"</span>, <span class='st'>"B"</span><span class='op'>]</span><span class='op'>]</span> - <span class='op'>)</span> -</div><div class='output co'>#> $par -#> parent_0 log_alpha log_beta sigma -#> 99.666192 2.549850 5.050586 1.890202 -#> -#> $objective -#> [1] 28.58291 -#> -#> $convergence -#> [1] 0 -#> -#> $iterations -#> [1] 21 -#> -#> $evaluations -#> function gradient -#> 25 78 -#> -#> $message -#> [1] "both X-convergence and relative convergence (5)" -#> </div></pre> + <div id="ref-examples"> + <h2>Examples</h2> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span></span></span> +<span class="r-in"><span> <span class="co"># Only use one core, to pass R CMD check --as-cran</span></span></span> +<span class="r-in"><span> <span class="va">fits</span> <span class="op"><-</span> <span class="fu"><a href="mmkin.html">mmkin</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"SFO"</span>, <span class="st">"FOMC"</span><span class="op">)</span>, <span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span>B <span class="op">=</span> <span class="va">FOCUS_2006_B</span>, C <span class="op">=</span> <span class="va">FOCUS_2006_C</span><span class="op">)</span>,</span></span> +<span class="r-in"><span> cores <span class="op">=</span> <span class="fl">1</span>, quiet <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span> +<span class="r-in"><span> <span class="va">fits</span><span class="op">[</span><span class="st">"FOMC"</span>, <span class="op">]</span></span></span> +<span class="r-out co"><span class="r-pr">#></span> <mmkin> object</span> +<span class="r-out co"><span class="r-pr">#></span> Status of individual fits:</span> +<span class="r-out co"><span class="r-pr">#></span> </span> +<span class="r-out co"><span class="r-pr">#></span> dataset</span> +<span class="r-out co"><span class="r-pr">#></span> model B C </span> +<span class="r-out co"><span class="r-pr">#></span> FOMC OK OK</span> +<span class="r-out co"><span class="r-pr">#></span> </span> +<span class="r-out co"><span class="r-pr">#></span> OK: No warnings</span> +<span class="r-in"><span> <span class="va">fits</span><span class="op">[</span>, <span class="st">"B"</span><span class="op">]</span></span></span> +<span class="r-out co"><span class="r-pr">#></span> <mmkin> object</span> +<span class="r-out co"><span class="r-pr">#></span> Status of individual fits:</span> +<span class="r-out co"><span class="r-pr">#></span> </span> +<span class="r-out co"><span class="r-pr">#></span> dataset</span> +<span class="r-out co"><span class="r-pr">#></span> model B </span> +<span class="r-out co"><span class="r-pr">#></span> SFO OK</span> +<span class="r-out co"><span class="r-pr">#></span> FOMC OK</span> +<span class="r-out co"><span class="r-pr">#></span> </span> +<span class="r-out co"><span class="r-pr">#></span> OK: No warnings</span> +<span class="r-in"><span> <span class="va">fits</span><span class="op">[</span><span class="st">"SFO"</span>, <span class="st">"B"</span><span class="op">]</span></span></span> +<span class="r-out co"><span class="r-pr">#></span> <mmkin> object</span> +<span class="r-out co"><span class="r-pr">#></span> Status of individual fits:</span> +<span class="r-out co"><span class="r-pr">#></span> </span> +<span class="r-out co"><span class="r-pr">#></span> dataset</span> +<span class="r-out co"><span class="r-pr">#></span> model B </span> +<span class="r-out co"><span class="r-pr">#></span> SFO OK</span> +<span class="r-out co"><span class="r-pr">#></span> </span> +<span class="r-out co"><span class="r-pr">#></span> OK: No warnings</span> +<span class="r-in"><span></span></span> +<span class="r-in"><span> <span class="fu"><a href="https://rdrr.io/r/utils/head.html" class="external-link">head</a></span><span class="op">(</span></span></span> +<span class="r-in"><span> <span class="co"># This extracts an mkinfit object with lots of components</span></span></span> +<span class="r-in"><span> <span class="va">fits</span><span class="op">[[</span><span class="st">"FOMC"</span>, <span class="st">"B"</span><span class="op">]</span><span class="op">]</span></span></span> +<span class="r-in"><span> <span class="op">)</span></span></span> +<span class="r-out co"><span class="r-pr">#></span> $par</span> +<span class="r-out co"><span class="r-pr">#></span> parent_0 log_alpha log_beta sigma </span> +<span class="r-out co"><span class="r-pr">#></span> 99.666192 2.549850 5.050586 1.890202 </span> +<span class="r-out co"><span class="r-pr">#></span> </span> +<span class="r-out co"><span class="r-pr">#></span> $objective</span> +<span class="r-out co"><span class="r-pr">#></span> [1] 28.58291</span> +<span class="r-out co"><span class="r-pr">#></span> </span> +<span class="r-out co"><span class="r-pr">#></span> $convergence</span> +<span class="r-out co"><span class="r-pr">#></span> [1] 0</span> +<span class="r-out co"><span class="r-pr">#></span> </span> +<span class="r-out co"><span class="r-pr">#></span> $iterations</span> +<span class="r-out co"><span class="r-pr">#></span> [1] 21</span> +<span class="r-out co"><span class="r-pr">#></span> </span> +<span class="r-out co"><span class="r-pr">#></span> $evaluations</span> +<span class="r-out co"><span class="r-pr">#></span> function gradient </span> +<span class="r-out co"><span class="r-pr">#></span> 25 78 </span> +<span class="r-out co"><span class="r-pr">#></span> </span> +<span class="r-out co"><span class="r-pr">#></span> $message</span> +<span class="r-out co"><span class="r-pr">#></span> [1] "both X-convergence and relative convergence (5)"</span> +<span class="r-out co"><span class="r-pr">#></span> </span> +</code></pre></div> + </div> </div> <div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar"> - <nav id="toc" data-toggle="toc" class="sticky-top"> - <h2 data-toc-skip>Contents</h2> - </nav> - </div> + <nav id="toc" data-toggle="toc" class="sticky-top"><h2 data-toc-skip>Contents</h2> + </nav></div> </div> - <footer> - <div class="copyright"> - <p>Developed by Johannes Ranke.</p> + <footer><div class="copyright"> + <p></p><p>Developed by Johannes Ranke.</p> </div> <div class="pkgdown"> - <p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.6.1.</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> + </footer></div> - </body> -</html> + + </body></html> |