aboutsummaryrefslogtreecommitdiff
path: root/docs/articles
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2016-11-04 15:38:09 +0100
committerJohannes Ranke <jranke@uni-bremen.de>2016-11-04 15:38:09 +0100
commit09f4f904af23a34d68d5d78482a5b9e12d9a9494 (patch)
tree60b61d802985e6a4328c57e32099e66217403026 /docs/articles
parentdb73a6bab3a60de98d020442e4ad103f47df9ab0 (diff)
Static documentation rebuilt by pkgdown::build_site()
With updated pkgdown with my PR
Diffstat (limited to 'docs/articles')
-rw-r--r--docs/articles/FOCUS_D.html10
-rw-r--r--docs/articles/FOCUS_L.html50
-rw-r--r--docs/articles/compiled_models.R13
-rw-r--r--docs/articles/compiled_models.html50
-rw-r--r--docs/articles/compiled_models_files/figure-html/benchmark_FOMC_SFO-1.pngbin9253 -> 9576 bytes
-rw-r--r--docs/articles/compiled_models_files/figure-html/benchmark_SFO_SFO-1.pngbin12123 -> 12059 bytes
-rw-r--r--docs/articles/index.html7
-rw-r--r--docs/articles/mkin.html12
8 files changed, 63 insertions, 79 deletions
diff --git a/docs/articles/FOCUS_D.html b/docs/articles/FOCUS_D.html
index 726c8378..f32d7f82 100644
--- a/docs/articles/FOCUS_D.html
+++ b/docs/articles/FOCUS_D.html
@@ -24,13 +24,7 @@
<li>
<a href="../news/index.html">News</a>
</li>
- </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 -->
+ </ul><ul class="nav navbar-nav navbar-right"></ul></div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
@@ -41,7 +35,7 @@
<h1>Example evaluation of FOCUS Example Dataset D</h1>
<h4 class="author">Johannes Ranke</h4>
- <h4 class="date">2016-11-03</h4>
+ <h4 class="date">2016-11-04</h4>
</div>
diff --git a/docs/articles/FOCUS_L.html b/docs/articles/FOCUS_L.html
index 55caa22e..6a9c6ba5 100644
--- a/docs/articles/FOCUS_L.html
+++ b/docs/articles/FOCUS_L.html
@@ -24,13 +24,7 @@
<li>
<a href="../news/index.html">News</a>
</li>
- </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 -->
+ </ul><ul class="nav navbar-nav navbar-right"></ul></div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
@@ -41,7 +35,7 @@
<h1>Example evaluation of FOCUS Laboratory Data L1 to L3</h1>
<h4 class="author">Johannes Ranke</h4>
- <h4 class="date">2016-11-03</h4>
+ <h4 class="date">2016-11-04</h4>
</div>
@@ -63,15 +57,15 @@ FOCUS_2006_L1_mkin &lt;-<span class="st"> </span><span class="kw"><a href="../re
<span class="kw">summary</span>(m.L1.SFO)</code></pre></div>
<pre><code>## mkin version: 0.9.44.9000
## R version: 3.3.2
-## Date of fit: Thu Nov 3 17:47:48 2016
-## Date of summary: Thu Nov 3 17:47:48 2016
+## Date of fit: Fri Nov 4 15:38:03 2016
+## Date of summary: Fri Nov 4 15:38:03 2016
##
## Equations:
## d_parent = - k_parent_sink * parent
##
## Model predictions using solution type analytical
##
-## Fitted with method Port using 37 model solutions performed in 0.093 s
+## Fitted with method Port using 37 model solutions performed in 0.089 s
##
## Weighting: none
##
@@ -156,8 +150,8 @@ FOCUS_2006_L1_mkin &lt;-<span class="st"> </span><span class="kw"><a href="../re
<div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r"><span class="kw">summary</span>(m.L1.FOMC, <span class="dt">data =</span> <span class="ot">FALSE</span>)</code></pre></div>
<pre><code>## mkin version: 0.9.44.9000
## R version: 3.3.2
-## Date of fit: Thu Nov 3 17:47:49 2016
-## Date of summary: Thu Nov 3 17:47:49 2016
+## Date of fit: Fri Nov 4 15:38:04 2016
+## Date of summary: Fri Nov 4 15:38:04 2016
##
##
## Warning: Optimisation by method Port did not converge.
@@ -169,7 +163,7 @@ FOCUS_2006_L1_mkin &lt;-<span class="st"> </span><span class="kw"><a href="../re
##
## Model predictions using solution type analytical
##
-## Fitted with method Port using 188 model solutions performed in 0.447 s
+## Fitted with method Port using 188 model solutions performed in 0.446 s
##
## Weighting: none
##
@@ -253,15 +247,15 @@ FOCUS_2006_L2_mkin &lt;-<span class="st"> </span><span class="kw"><a href="../re
<div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r"><span class="kw">summary</span>(m.L2.FOMC, <span class="dt">data =</span> <span class="ot">FALSE</span>)</code></pre></div>
<pre><code>## mkin version: 0.9.44.9000
## R version: 3.3.2
-## Date of fit: Thu Nov 3 17:47:49 2016
-## Date of summary: Thu Nov 3 17:47:49 2016
+## Date of fit: Fri Nov 4 15:38:05 2016
+## Date of summary: Fri Nov 4 15:38:05 2016
##
## Equations:
## d_parent = - (alpha/beta) * 1/((time/beta) + 1) * parent
##
## Model predictions using solution type analytical
##
-## Fitted with method Port using 81 model solutions performed in 0.189 s
+## Fitted with method Port using 81 model solutions performed in 0.19 s
##
## Weighting: none
##
@@ -323,8 +317,8 @@ FOCUS_2006_L2_mkin &lt;-<span class="st"> </span><span class="kw"><a href="../re
<div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r"><span class="kw">summary</span>(m.L2.DFOP, <span class="dt">data =</span> <span class="ot">FALSE</span>)</code></pre></div>
<pre><code>## mkin version: 0.9.44.9000
## R version: 3.3.2
-## Date of fit: Thu Nov 3 17:47:50 2016
-## Date of summary: Thu Nov 3 17:47:50 2016
+## Date of fit: Fri Nov 4 15:38:06 2016
+## Date of summary: Fri Nov 4 15:38:06 2016
##
## Equations:
## d_parent = - ((k1 * g * exp(-k1 * time) + k2 * (1 - g) * exp(-k2 *
@@ -333,7 +327,7 @@ FOCUS_2006_L2_mkin &lt;-<span class="st"> </span><span class="kw"><a href="../re
##
## Model predictions using solution type analytical
##
-## Fitted with method Port using 336 model solutions performed in 0.836 s
+## Fitted with method Port using 336 model solutions performed in 0.815 s
##
## Weighting: none
##
@@ -412,8 +406,8 @@ mm.L3 &lt;-<span class="st"> </span><span class="kw"><a href="../reference/mmkin
<div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r"><span class="kw">summary</span>(mm.L3[[<span class="st">"DFOP"</span>, <span class="dv">1</span>]])</code></pre></div>
<pre><code>## mkin version: 0.9.44.9000
## R version: 3.3.2
-## Date of fit: Thu Nov 3 17:47:51 2016
-## Date of summary: Thu Nov 3 17:47:52 2016
+## Date of fit: Fri Nov 4 15:38:07 2016
+## Date of summary: Fri Nov 4 15:38:07 2016
##
## Equations:
## d_parent = - ((k1 * g * exp(-k1 * time) + k2 * (1 - g) * exp(-k2 *
@@ -422,7 +416,7 @@ mm.L3 &lt;-<span class="st"> </span><span class="kw"><a href="../reference/mmkin
##
## Model predictions using solution type analytical
##
-## Fitted with method Port using 137 model solutions performed in 0.328 s
+## Fitted with method Port using 137 model solutions performed in 0.339 s
##
## Weighting: none
##
@@ -512,15 +506,15 @@ mm.L4 &lt;-<span class="st"> </span><span class="kw"><a href="../reference/mmkin
<div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r"><span class="kw">summary</span>(mm.L4[[<span class="st">"SFO"</span>, <span class="dv">1</span>]], <span class="dt">data =</span> <span class="ot">FALSE</span>)</code></pre></div>
<pre><code>## mkin version: 0.9.44.9000
## R version: 3.3.2
-## Date of fit: Thu Nov 3 17:47:52 2016
-## Date of summary: Thu Nov 3 17:47:52 2016
+## Date of fit: Fri Nov 4 15:38:07 2016
+## Date of summary: Fri Nov 4 15:38:08 2016
##
## Equations:
## d_parent = - k_parent_sink * parent
##
## Model predictions using solution type analytical
##
-## Fitted with method Port using 46 model solutions performed in 0.107 s
+## Fitted with method Port using 46 model solutions performed in 0.112 s
##
## Weighting: none
##
@@ -572,8 +566,8 @@ mm.L4 &lt;-<span class="st"> </span><span class="kw"><a href="../reference/mmkin
<div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r"><span class="kw">summary</span>(mm.L4[[<span class="st">"FOMC"</span>, <span class="dv">1</span>]], <span class="dt">data =</span> <span class="ot">FALSE</span>)</code></pre></div>
<pre><code>## mkin version: 0.9.44.9000
## R version: 3.3.2
-## Date of fit: Thu Nov 3 17:47:52 2016
-## Date of summary: Thu Nov 3 17:47:52 2016
+## Date of fit: Fri Nov 4 15:38:08 2016
+## Date of summary: Fri Nov 4 15:38:08 2016
##
## Equations:
## d_parent = - (alpha/beta) * 1/((time/beta) + 1) * parent
diff --git a/docs/articles/compiled_models.R b/docs/articles/compiled_models.R
index 4f544b0d..5ce343cb 100644
--- a/docs/articles/compiled_models.R
+++ b/docs/articles/compiled_models.R
@@ -1,3 +1,16 @@
+## ---- include = FALSE----------------------------------------------------
+library(knitr)
+opts_chunk$set(tidy = FALSE, cache = FALSE)
+
+## ----check_gcc-----------------------------------------------------------
+Sys.which("gcc")
+
+## ----create_SFO_SFO------------------------------------------------------
+library("mkin")
+SFO_SFO <- mkinmod(
+ parent = mkinsub("SFO", "m1"),
+ m1 = mkinsub("SFO"))
+
## ----benchmark_SFO_SFO, fig.height = 3-----------------------------------
library("microbenchmark")
library("ggplot2")
diff --git a/docs/articles/compiled_models.html b/docs/articles/compiled_models.html
index 5a04168e..09039f62 100644
--- a/docs/articles/compiled_models.html
+++ b/docs/articles/compiled_models.html
@@ -24,13 +24,7 @@
<li>
<a href="../news/index.html">News</a>
</li>
- </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 -->
+ </ul><ul class="nav navbar-nav navbar-right"></ul></div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
@@ -41,14 +35,14 @@
<h1>Performance benefit by using compiled model definitions in mkin</h1>
<h4 class="author">Johannes Ranke</h4>
- <h4 class="date">2016-11-03</h4>
+ <h4 class="date">2016-11-04</h4>
</div>
<div class="contents">
-<div id="benchmark-for-a-model-that-can-also-be-solved-with-eigenvalues" class="section level2">
-<h2 class="hasAnchor"><html><body><a href="#benchmark-for-a-model-that-can-also-be-solved-with-eigenvalues" class="anchor"> </a></body></html>Benchmark for a model that can also be solved with Eigenvalues</h2>
+<div id="model-that-can-also-be-solved-with-eigenvalues" class="section level2">
+<h2 class="hasAnchor"><html><body><a href="#model-that-can-also-be-solved-with-eigenvalues" class="anchor"> </a></body></html>Model that can also be solved with Eigenvalues</h2>
<p>This evaluation is taken from the example section of mkinfit. When using an mkin version equal to or greater than 0.9-36 and a C compiler (gcc) is available, you will see a message that the model is being compiled from autogenerated C code when defining a model using mkinmod. The <code><a href="../reference/mkinmod.html">mkinmod()</a></code> function checks for presence of the gcc compiler using</p>
<div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r"><span class="kw">Sys.which</span>(<span class="st">"gcc"</span>)</code></pre></div>
<pre><code>## gcc
@@ -78,25 +72,25 @@ mb<span class="fl">.1</span> &lt;-<span class="st"> </span><span class="kw">micr
<span class="kw">print</span>(mb<span class="fl">.1</span>)</code></pre></div>
<pre><code>## Unit: milliseconds
## expr min lq mean median uq
-## deSolve, not compiled 6306.4527 6340.7895 6403.5937 6375.1264 6452.1643
-## Eigenvalue based 918.0808 929.7217 948.9742 941.3626 964.4210
-## deSolve, compiled 736.1337 753.6016 773.5605 771.0696 792.2739
+## deSolve, not compiled 6581.1731 6598.7831 6630.0395 6616.3931 6654.4726
+## Eigenvalue based 880.1617 890.3517 911.2758 900.5416 926.8328
+## deSolve, compiled 739.4343 749.6078 753.6543 759.7813 760.7643
## max neval cld
-## 6529.2022 3 b
-## 987.4793 3 a
-## 813.4783 3 a</code></pre>
+## 6692.5522 3 c
+## 953.1240 3 b
+## 761.7474 3 a</code></pre>
<div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r"><span class="kw">autoplot</span>(mb<span class="fl">.1</span>)</code></pre></div>
<p><img src="compiled_models_files/figure-html/benchmark_SFO_SFO-1.png" width="672"></p>
-<p>We see that using the compiled model is by a factor of 8.3 faster than using the R version with the default ode solver, and it is even faster than the Eigenvalue based solution implemented in R which does not need iterative solution of the ODEs:</p>
+<p>We see that using the compiled model is by a factor of 8.7 faster than using the R version with the default ode solver, and it is even faster than the Eigenvalue based solution implemented in R which does not need iterative solution of the ODEs:</p>
<div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r"><span class="kw">rownames</span>(smb<span class="fl">.1</span>) &lt;-<span class="st"> </span>smb<span class="fl">.1</span>$expr
smb<span class="fl">.1</span>[<span class="st">"median"</span>]/smb<span class="fl">.1</span>[<span class="st">"deSolve, compiled"</span>, <span class="st">"median"</span>]</code></pre></div>
<pre><code>## median
-## deSolve, not compiled 8.267900
-## Eigenvalue based 1.220853
+## deSolve, not compiled 8.708286
+## Eigenvalue based 1.185264
## deSolve, compiled 1.000000</code></pre>
</div>
-<div id="benchmark-for-a-model-that-can-not-be-solved-with-eigenvalues" class="section level2">
-<h2 class="hasAnchor"><html><body><a href="#benchmark-for-a-model-that-can-not-be-solved-with-eigenvalues" class="anchor"> </a></body></html>Benchmark for a model that can not be solved with Eigenvalues</h2>
+<div id="model-that-can-not-be-solved-with-eigenvalues" class="section level2">
+<h2 class="hasAnchor"><html><body><a href="#model-that-can-not-be-solved-with-eigenvalues" class="anchor"> </a></body></html>Model that can not be solved with Eigenvalues</h2>
<p>This evaluation is also taken from the example section of mkinfit.</p>
<div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r">FOMC_SFO &lt;-<span class="st"> </span><span class="kw"><a href="../reference/mkinmod.html">mkinmod</a></span>(
<span class="dt">parent =</span> <span class="kw"><a href="../reference/mkinsub.html">mkinsub</a></span>(<span class="st">"FOMC"</span>, <span class="st">"m1"</span>),
@@ -114,18 +108,18 @@ smb<span class="fl">.1</span>[<span class="st">"median"</span>]/smb<span class="
<span class="kw">print</span>(mb<span class="fl">.2</span>)</code></pre></div>
<pre><code>## Unit: seconds
## expr min lq mean median uq
-## deSolve, not compiled 13.604720 13.667244 13.689764 13.729768 13.732286
-## deSolve, compiled 1.305077 1.311124 1.328943 1.317172 1.340876
+## deSolve, not compiled 13.756286 13.813205 13.874083 13.870125 13.932982
+## deSolve, compiled 1.323196 1.372916 1.391915 1.422635 1.426274
## max neval cld
-## 13.734804 3 b
-## 1.364579 3 a</code></pre>
+## 13.995838 3 b
+## 1.429913 3 a</code></pre>
<div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r">smb<span class="fl">.2</span>[<span class="st">"median"</span>]/smb<span class="fl">.2</span>[<span class="st">"deSolve, compiled"</span>, <span class="st">"median"</span>]</code></pre></div>
<pre><code>## median
## 1 NA
## 2 NA</code></pre>
<div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r"><span class="kw">autoplot</span>(mb<span class="fl">.2</span>)</code></pre></div>
<p><img src="compiled_models_files/figure-html/benchmark_FOMC_SFO-1.png" width="672"></p>
-<p>Here we get a performance benefit of a factor of 10.4 using the version of the differential equation model compiled from C code!</p>
+<p>Here we get a performance benefit of a factor of 9.7 using the version of the differential equation model compiled from C code!</p>
<p>This vignette was built with mkin 0.9.44.9000 on</p>
<pre><code>## R version 3.3.2 (2016-10-31)
## Platform: x86_64-pc-linux-gnu (64-bit)
@@ -138,8 +132,8 @@ smb<span class="fl">.1</span>[<span class="st">"median"</span>]/smb<span class="
<div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
<div id="tocnav">
<h2>Contents</h2>
- <ul class="nav nav-pills nav-stacked"><li><a href="#benchmark-for-a-model-that-can-also-be-solved-with-eigenvalues">Benchmark for a model that can also be solved with Eigenvalues</a></li>
- <li><a href="#benchmark-for-a-model-that-can-not-be-solved-with-eigenvalues">Benchmark for a model that can not be solved with Eigenvalues</a></li>
+ <ul class="nav nav-pills nav-stacked"><li><a href="#model-that-can-also-be-solved-with-eigenvalues">Model that can also be solved with Eigenvalues</a></li>
+ <li><a href="#model-that-can-not-be-solved-with-eigenvalues">Model that can not be solved with Eigenvalues</a></li>
</ul></div>
</div>
diff --git a/docs/articles/compiled_models_files/figure-html/benchmark_FOMC_SFO-1.png b/docs/articles/compiled_models_files/figure-html/benchmark_FOMC_SFO-1.png
index eec55773..51846e6c 100644
--- a/docs/articles/compiled_models_files/figure-html/benchmark_FOMC_SFO-1.png
+++ b/docs/articles/compiled_models_files/figure-html/benchmark_FOMC_SFO-1.png
Binary files differ
diff --git a/docs/articles/compiled_models_files/figure-html/benchmark_SFO_SFO-1.png b/docs/articles/compiled_models_files/figure-html/benchmark_SFO_SFO-1.png
index b043c13b..f6e4cb08 100644
--- a/docs/articles/compiled_models_files/figure-html/benchmark_SFO_SFO-1.png
+++ b/docs/articles/compiled_models_files/figure-html/benchmark_SFO_SFO-1.png
Binary files differ
diff --git a/docs/articles/index.html b/docs/articles/index.html
index cd6a7bea..9f7cdd74 100644
--- a/docs/articles/index.html
+++ b/docs/articles/index.html
@@ -60,12 +60,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 -->
diff --git a/docs/articles/mkin.html b/docs/articles/mkin.html
index dafaa0e4..5f6ae46c 100644
--- a/docs/articles/mkin.html
+++ b/docs/articles/mkin.html
@@ -24,13 +24,7 @@
<li>
<a href="../news/index.html">News</a>
</li>
- </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 -->
+ </ul><ul class="nav navbar-nav navbar-right"></ul></div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
@@ -41,7 +35,7 @@
<h1>mkin - Kinetic evaluation of chemical degradation data</h1>
<h4 class="author">Johannes Ranke</h4>
- <h4 class="date">2016-11-03</h4>
+ <h4 class="date">2016-11-04</h4>
</div>
@@ -70,7 +64,7 @@ d_SFO_SFO_SFO_err &lt;-<span class="st"> </span><span class="kw"><a href="../ref
f_SFO_SFO_SFO &lt;-<span class="st"> </span><span class="kw"><a href="../reference/mkinfit.html">mkinfit</a></span>(m_SFO_SFO_SFO, d_SFO_SFO_SFO_err[[<span class="dv">1</span>]], <span class="dt">quiet =</span> <span class="ot">TRUE</span>)
-<span class="kw">plot_sep</span>(f_SFO_SFO_SFO, <span class="dt">lpos =</span> <span class="kw">c</span>(<span class="st">"topright"</span>, <span class="st">"bottomright"</span>, <span class="st">"bottomright"</span>))</code></pre></div>
+<span class="kw"><a href="../reference/plot.mkinfit.html">plot_sep</a></span>(f_SFO_SFO_SFO, <span class="dt">lpos =</span> <span class="kw">c</span>(<span class="st">"topright"</span>, <span class="st">"bottomright"</span>, <span class="st">"bottomright"</span>))</code></pre></div>
<p><img src="mkin_files/figure-html/unnamed-chunk-2-1.png" width="768"></p>
</div>
<div id="background" class="section level1">

Contact - Imprint