diff options
| author | Johannes Ranke <jranke@uni-bremen.de> | 2018-03-01 14:32:46 +0100 | 
|---|---|---|
| committer | Johannes Ranke <jranke@uni-bremen.de> | 2018-03-01 14:32:46 +0100 | 
| commit | 6653ff2507f45eae909f491a9af3f1eb5358a600 (patch) | |
| tree | 03a43f9cf86cc1d675eba1c6f9c5e31da9c2acdd /docs/reference/mmkin.html | |
| parent | a767013f407f7495492af6a1ceba4cf2b8aae839 (diff) | |
Static documentation rebuilt using current pkgdown::build_site()
Diffstat (limited to 'docs/reference/mmkin.html')
| -rw-r--r-- | docs/reference/mmkin.html | 66 | 
1 files changed, 33 insertions, 33 deletions
| diff --git a/docs/reference/mmkin.html b/docs/reference/mmkin.html index d649563f..e97e3f81 100644 --- a/docs/reference/mmkin.html +++ b/docs/reference/mmkin.html @@ -18,12 +18,20 @@  <!-- Font Awesome icons -->  <link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-T8Gy5hrqNKT+hzMclPo118YTQO6cYprQmhrYwIiQ/3axmI1hQomh7Ud2hPOy8SP1" crossorigin="anonymous"> +<!-- clipboard.js --> +<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.7.1/clipboard.min.js" integrity="sha384-cV+rhyOuRHc9Ub/91rihWcGmMmCXDeksTtCihMupQHSsi8GIIRDG0ThDc3HGQFJ3" crossorigin="anonymous"></script>  <!-- pkgdown -->  <link href="../pkgdown.css" rel="stylesheet">  <script src="../jquery.sticky-kit.min.js"></script>  <script src="../pkgdown.js"></script> +   +   +<meta property="og:title" content="Fit one or more kinetic models with one or more state variables to one or more datasets — mmkin" /> +<meta property="og:description" content="This function calls mkinfit on all combinations of models and datasets +  specified in its first two arguments." /> +<meta name="twitter:card" content="summary" />  <!-- mathjax -->  <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -70,6 +78,9 @@        <a href="../articles/FOCUS_L.html">Example evaluation of FOCUS Laboratory Data L1 to L3</a>      </li>      <li> +      <a href="../articles/FOCUS_Z.html">Example evaluation of FOCUS Example Dataset Z</a> +    </li> +    <li>        <a href="../articles/compiled_models.html">Performance benefit by using compiled model definitions in mkin</a>      </li>      <li> @@ -83,12 +94,7 @@        </ul>        <ul class="nav navbar-nav navbar-right"> -        <li> -  <a href="http://github.com/jranke/mkin"> -    <span class="fa fa-github fa-lg"></span> -      -  </a> -</li> +                </ul>      </div><!--/.nav-collapse -->    </div><!--/.container --> @@ -152,45 +158,39 @@      <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2> -    <pre class="examples"><div class='input'> +    <pre class="examples"><span class='co'># NOT RUN {</span>  <span class='no'>m_synth_SFO_lin</span> <span class='kw'><-</span> <span class='fu'><a href='mkinmod.html'>mkinmod</a></span>(<span class='kw'>parent</span> <span class='kw'>=</span> <span class='fu'><a href='mkinsub.html'>mkinsub</a></span>(<span class='st'>"SFO"</span>, <span class='st'>"M1"</span>),                             <span class='kw'>M1</span> <span class='kw'>=</span> <span class='fu'><a href='mkinsub.html'>mkinsub</a></span>(<span class='st'>"SFO"</span>, <span class='st'>"M2"</span>), -                           <span class='kw'>M2</span> <span class='kw'>=</span> <span class='fu'><a href='mkinsub.html'>mkinsub</a></span>(<span class='st'>"SFO"</span>), <span class='kw'>use_of_ff</span> <span class='kw'>=</span> <span class='st'>"max"</span>)</div><div class='output co'>#> <span class='message'>Successfully compiled differential equation model from auto-generated C code.</span></div><div class='input'> +                           <span class='kw'>M2</span> <span class='kw'>=</span> <span class='fu'><a href='mkinsub.html'>mkinsub</a></span>(<span class='st'>"SFO"</span>), <span class='kw'>use_of_ff</span> <span class='kw'>=</span> <span class='st'>"max"</span>) +  <span class='no'>m_synth_FOMC_lin</span> <span class='kw'><-</span> <span class='fu'><a href='mkinmod.html'>mkinmod</a></span>(<span class='kw'>parent</span> <span class='kw'>=</span> <span class='fu'><a href='mkinsub.html'>mkinsub</a></span>(<span class='st'>"FOMC"</span>, <span class='st'>"M1"</span>),                              <span class='kw'>M1</span> <span class='kw'>=</span> <span class='fu'><a href='mkinsub.html'>mkinsub</a></span>(<span class='st'>"SFO"</span>, <span class='st'>"M2"</span>), -                            <span class='kw'>M2</span> <span class='kw'>=</span> <span class='fu'><a href='mkinsub.html'>mkinsub</a></span>(<span class='st'>"SFO"</span>), <span class='kw'>use_of_ff</span> <span class='kw'>=</span> <span class='st'>"max"</span>)</div><div class='output co'>#> <span class='message'>Successfully compiled differential equation model from auto-generated C code.</span></div><div class='input'> +                            <span class='kw'>M2</span> <span class='kw'>=</span> <span class='fu'><a href='mkinsub.html'>mkinsub</a></span>(<span class='st'>"SFO"</span>), <span class='kw'>use_of_ff</span> <span class='kw'>=</span> <span class='st'>"max"</span>) +  <span class='no'>models</span> <span class='kw'><-</span> <span class='fu'>list</span>(<span class='kw'>SFO_lin</span> <span class='kw'>=</span> <span class='no'>m_synth_SFO_lin</span>, <span class='kw'>FOMC_lin</span> <span class='kw'>=</span> <span class='no'>m_synth_FOMC_lin</span>)  <span class='no'>datasets</span> <span class='kw'><-</span> <span class='fu'>lapply</span>(<span class='no'>synthetic_data_for_UBA_2014</span>[<span class='fl'>1</span>:<span class='fl'>3</span>], <span class='kw'>function</span>(<span class='no'>x</span>) <span class='no'>x</span>$<span class='no'>data</span>)  <span class='fu'>names</span>(<span class='no'>datasets</span>) <span class='kw'><-</span> <span class='fu'>paste</span>(<span class='st'>"Dataset"</span>, <span class='fl'>1</span>:<span class='fl'>3</span>)  <span class='no'>time_default</span> <span class='kw'><-</span> <span class='fu'>system.time</span>(<span class='no'>fits.0</span> <span class='kw'><-</span> <span class='fu'>mmkin</span>(<span class='no'>models</span>, <span class='no'>datasets</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>)) -<span class='no'>time_1</span> <span class='kw'><-</span> <span class='fu'>system.time</span>(<span class='no'>fits.4</span> <span class='kw'><-</span> <span class='fu'>mmkin</span>(<span class='no'>models</span>, <span class='no'>datasets</span>, <span class='kw'>cores</span> <span class='kw'>=</span> <span class='fl'>1</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>))</div><div class='output co'>#> <span class='warning'>Warning: Optimisation by method Port did not converge.</span> -#> <span class='warning'>Convergence code is 1</span></div><div class='output co'>#> <span class='warning'>Warning: Optimisation by method Port did not converge.</span> -#> <span class='warning'>Convergence code is 1</span></div><div class='input'> -<span class='no'>time_default</span></div><div class='output co'>#>    user  system elapsed  -#>  15.992   0.188  11.440 </div><div class='input'><span class='no'>time_1</span></div><div class='output co'>#>    user  system elapsed  -#>  24.576   0.000  24.578 </div><div class='input'> -<span class='fu'><a href='endpoints.html'>endpoints</a></span>(<span class='no'>fits.0</span><span class='kw'>[[</span><span class='st'>"SFO_lin"</span>, <span class='fl'>2</span>]])</div><div class='output co'>#> $ff -#>   parent_M1 parent_sink       M1_M2     M1_sink  -#>   0.7340479   0.2659521   0.7505687   0.2494313  -#>  -#> $SFORB -#> logical(0) -#>  -#> $distimes -#>              DT50       DT90 -#> parent  0.8777689   2.915885 -#> M1      2.3257456   7.725960 -#> M2     33.7200862 112.015702 -#> </div><div class='input'> +<span class='no'>time_1</span> <span class='kw'><-</span> <span class='fu'>system.time</span>(<span class='no'>fits.4</span> <span class='kw'><-</span> <span class='fu'>mmkin</span>(<span class='no'>models</span>, <span class='no'>datasets</span>, <span class='kw'>cores</span> <span class='kw'>=</span> <span class='fl'>1</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>)) + +<span class='no'>time_default</span> +<span class='no'>time_1</span> + +<span class='fu'><a href='endpoints.html'>endpoints</a></span>(<span class='no'>fits.0</span><span class='kw'>[[</span><span class='st'>"SFO_lin"</span>, <span class='fl'>2</span>]]) +  <span class='co'># plot.mkinfit handles rows or columns of mmkin result objects</span> -<span class='fu'>plot</span>(<span class='no'>fits.0</span>[<span class='fl'>1</span>, ])</div><img src='mmkin-15.png' alt='' width='540' height='400' /><div class='input'><span class='fu'>plot</span>(<span class='no'>fits.0</span>[<span class='fl'>1</span>, ], <span class='kw'>obs_var</span> <span class='kw'>=</span> <span class='fu'>c</span>(<span class='st'>"M1"</span>, <span class='st'>"M2"</span>))</div><img src='mmkin-17.png' alt='' width='540' height='400' /><div class='input'><span class='fu'>plot</span>(<span class='no'>fits.0</span>[, <span class='fl'>1</span>])</div><img src='mmkin-19.png' alt='' width='540' height='400' /><div class='input'><span class='co'># Use double brackets to extract a single mkinfit object, which will be plotted</span> +<span class='fu'>plot</span>(<span class='no'>fits.0</span>[<span class='fl'>1</span>, ]) +<span class='fu'>plot</span>(<span class='no'>fits.0</span>[<span class='fl'>1</span>, ], <span class='kw'>obs_var</span> <span class='kw'>=</span> <span class='fu'>c</span>(<span class='st'>"M1"</span>, <span class='st'>"M2"</span>)) +<span class='fu'>plot</span>(<span class='no'>fits.0</span>[, <span class='fl'>1</span>]) +<span class='co'># Use double brackets to extract a single mkinfit object, which will be plotted</span>  <span class='co'># by plot.mkinfit and can be plotted using plot_sep</span> -<span class='fu'>plot</span>(<span class='no'>fits.0</span><span class='kw'>[[</span><span class='fl'>1</span>, <span class='fl'>1</span>]], <span class='kw'>sep_obs</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>show_residuals</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>show_errmin</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>)</div><img src='mmkin-21.png' alt='' width='540' height='400' /><div class='input'><span class='fu'><a href='plot.mkinfit.html'>plot_sep</a></span>(<span class='no'>fits.0</span><span class='kw'>[[</span><span class='fl'>1</span>, <span class='fl'>1</span>]]) +<span class='fu'>plot</span>(<span class='no'>fits.0</span><span class='kw'>[[</span><span class='fl'>1</span>, <span class='fl'>1</span>]], <span class='kw'>sep_obs</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>show_residuals</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>show_errmin</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>) +<span class='fu'><a href='plot.mkinfit.html'>plot_sep</a></span>(<span class='no'>fits.0</span><span class='kw'>[[</span><span class='fl'>1</span>, <span class='fl'>1</span>]])  <span class='co'># Plotting with mmkin (single brackets, extracting an mmkin object) does not</span>  <span class='co'># allow to plot the observed variables separately</span> -<span class='fu'>plot</span>(<span class='no'>fits.0</span>[<span class='fl'>1</span>, <span class='fl'>1</span>])</div><img src='mmkin-23.png' alt='' width='540' height='400' /><div class='input'> -</div></pre> +<span class='fu'>plot</span>(<span class='no'>fits.0</span>[<span class='fl'>1</span>, <span class='fl'>1</span>]) +<span class='co'># }</span></pre>    </div>    <div class="col-md-3 hidden-xs hidden-sm" id="sidebar">      <h2>Contents</h2> @@ -217,7 +217,7 @@  </div>  <div class="pkgdown"> -  <p>Site built with <a href="http://hadley.github.io/pkgdown/">pkgdown</a>.</p> +  <p>Site built with <a href="http://pkgdown.r-lib.org/">pkgdown</a>.</p>  </div>        </footer> | 
