aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/create_deg_func.html
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2022-11-17 14:54:20 +0100
committerJohannes Ranke <jranke@uni-bremen.de>2022-11-17 14:56:25 +0100
commite5d1df9a9b1f0951d7dfbaf24eee4294470b73e2 (patch)
tree18740ef050a68d1a6fe91f1bd2fdfdd97ac6448b /docs/reference/create_deg_func.html
parent90354f5cd9e095f9ef98424689a2716770b248d4 (diff)
Complete update of online docs for v1.2.0
Diffstat (limited to 'docs/reference/create_deg_func.html')
-rw-r--r--docs/reference/create_deg_func.html73
1 files changed, 42 insertions, 31 deletions
diff --git a/docs/reference/create_deg_func.html b/docs/reference/create_deg_func.html
index b85acb7a..b93f1c4a 100644
--- a/docs/reference/create_deg_func.html
+++ b/docs/reference/create_deg_func.html
@@ -17,7 +17,7 @@
</button>
<span class="navbar-brand">
<a class="navbar-link" href="../index.html">mkin</a>
- <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">1.1.0</span>
+ <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">1.2.0</span>
</span>
</div>
@@ -44,19 +44,25 @@
<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>
<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>
+ <li>
+ <a href="../articles/web_only/saem_benchmarks.html">Benchmark timings for saem.mmkin</a>
</li>
</ul></li>
<li>
@@ -87,59 +93,64 @@
</div>
<div id="ref-usage">
- <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">create_deg_func</span><span class="op">(</span><span class="va">spec</span>, use_of_ff <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">"min"</span>, <span class="st">"max"</span><span class="op">)</span><span class="op">)</span></code></pre></div>
+ <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">create_deg_func</span><span class="op">(</span><span class="va">spec</span>, use_of_ff <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">"min"</span>, <span class="st">"max"</span><span class="op">)</span><span class="op">)</span></span></code></pre></div>
</div>
<div id="arguments">
<h2>Arguments</h2>
<dl><dt>spec</dt>
<dd><p>List of model specifications as contained in mkinmod objects</p></dd>
+
+
<dt>use_of_ff</dt>
<dd><p>Minimum or maximum use of formation fractions</p></dd>
+
</dl></div>
<div id="value">
<h2>Value</h2>
- <p>Degradation function to be attached to mkinmod objects</p>
+
+
+<p>Degradation function to be attached to mkinmod objects</p>
</div>
<div id="ref-examples">
<h2>Examples</h2>
- <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"></span>
-<span class="r-in"><span class="va">SFO_SFO</span> <span class="op">&lt;-</span> <span class="fu"><a href="mkinmod.html">mkinmod</a></span><span class="op">(</span></span>
-<span class="r-in"> parent <span class="op">=</span> <span class="fu"><a href="mkinmod.html">mkinsub</a></span><span class="op">(</span><span class="st">"SFO"</span>, <span class="st">"m1"</span><span class="op">)</span>,</span>
-<span class="r-in"> m1 <span class="op">=</span> <span class="fu"><a href="mkinmod.html">mkinsub</a></span><span class="op">(</span><span class="st">"SFO"</span><span class="op">)</span><span class="op">)</span></span>
+ <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span></span></span>
+<span class="r-in"><span><span class="va">SFO_SFO</span> <span class="op">&lt;-</span> <span class="fu"><a href="mkinmod.html">mkinmod</a></span><span class="op">(</span></span></span>
+<span class="r-in"><span> parent <span class="op">=</span> <span class="fu"><a href="mkinmod.html">mkinsub</a></span><span class="op">(</span><span class="st">"SFO"</span>, <span class="st">"m1"</span><span class="op">)</span>,</span></span>
+<span class="r-in"><span> m1 <span class="op">=</span> <span class="fu"><a href="mkinmod.html">mkinsub</a></span><span class="op">(</span><span class="st">"SFO"</span><span class="op">)</span><span class="op">)</span></span></span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> Temporary DLL for differentials generated and loaded</span>
-<span class="r-in"><span class="va">FOCUS_D</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/subset.html" class="external-link">subset</a></span><span class="op">(</span><span class="va">FOCUS_2006_D</span>, <span class="va">value</span> <span class="op">!=</span> <span class="fl">0</span><span class="op">)</span> <span class="co"># to avoid warnings</span></span>
-<span class="r-in"><span class="va">fit_1</span> <span class="op">&lt;-</span> <span class="fu"><a href="mkinfit.html">mkinfit</a></span><span class="op">(</span><span class="va">SFO_SFO</span>, <span class="va">FOCUS_D</span>, solution_type <span class="op">=</span> <span class="st">"analytical"</span>, quiet <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span>
-<span class="r-in"><span class="co"># \dontrun{</span></span>
-<span class="r-in"><span class="va">fit_2</span> <span class="op">&lt;-</span> <span class="fu"><a href="mkinfit.html">mkinfit</a></span><span class="op">(</span><span class="va">SFO_SFO</span>, <span class="va">FOCUS_D</span>, solution_type <span class="op">=</span> <span class="st">"deSolve"</span>, quiet <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span>
-<span class="r-in"><span class="kw">if</span> <span class="op">(</span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">require</a></span><span class="op">(</span><span class="va"><a href="http://rbenchmark.googlecode.com" class="external-link">rbenchmark</a></span><span class="op">)</span><span class="op">)</span></span>
-<span class="r-in"> <span class="fu">benchmark</span><span class="op">(</span></span>
-<span class="r-in"> analytical <span class="op">=</span> <span class="fu"><a href="mkinfit.html">mkinfit</a></span><span class="op">(</span><span class="va">SFO_SFO</span>, <span class="va">FOCUS_D</span>, solution_type <span class="op">=</span> <span class="st">"analytical"</span>, quiet <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span>,</span>
-<span class="r-in"> deSolve <span class="op">=</span> <span class="fu"><a href="mkinfit.html">mkinfit</a></span><span class="op">(</span><span class="va">SFO_SFO</span>, <span class="va">FOCUS_D</span>, solution_type <span class="op">=</span> <span class="st">"deSolve"</span>, quiet <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span>,</span>
-<span class="r-in"> replications <span class="op">=</span> <span class="fl">2</span><span class="op">)</span></span>
+<span class="r-in"><span><span class="va">FOCUS_D</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/subset.html" class="external-link">subset</a></span><span class="op">(</span><span class="va">FOCUS_2006_D</span>, <span class="va">value</span> <span class="op">!=</span> <span class="fl">0</span><span class="op">)</span> <span class="co"># to avoid warnings</span></span></span>
+<span class="r-in"><span><span class="va">fit_1</span> <span class="op">&lt;-</span> <span class="fu"><a href="mkinfit.html">mkinfit</a></span><span class="op">(</span><span class="va">SFO_SFO</span>, <span class="va">FOCUS_D</span>, solution_type <span class="op">=</span> <span class="st">"analytical"</span>, quiet <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span>
+<span class="r-in"><span><span class="co"># \dontrun{</span></span></span>
+<span class="r-in"><span><span class="va">fit_2</span> <span class="op">&lt;-</span> <span class="fu"><a href="mkinfit.html">mkinfit</a></span><span class="op">(</span><span class="va">SFO_SFO</span>, <span class="va">FOCUS_D</span>, solution_type <span class="op">=</span> <span class="st">"deSolve"</span>, quiet <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span>
+<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">require</a></span><span class="op">(</span><span class="va"><a href="http://rbenchmark.googlecode.com" class="external-link">rbenchmark</a></span><span class="op">)</span><span class="op">)</span></span></span>
+<span class="r-in"><span> <span class="fu"><a href="https://rdrr.io/pkg/rbenchmark/man/benchmark.html" class="external-link">benchmark</a></span><span class="op">(</span></span></span>
+<span class="r-in"><span> analytical <span class="op">=</span> <span class="fu"><a href="mkinfit.html">mkinfit</a></span><span class="op">(</span><span class="va">SFO_SFO</span>, <span class="va">FOCUS_D</span>, solution_type <span class="op">=</span> <span class="st">"analytical"</span>, quiet <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span>,</span></span>
+<span class="r-in"><span> deSolve <span class="op">=</span> <span class="fu"><a href="mkinfit.html">mkinfit</a></span><span class="op">(</span><span class="va">SFO_SFO</span>, <span class="va">FOCUS_D</span>, solution_type <span class="op">=</span> <span class="st">"deSolve"</span>, quiet <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span>,</span></span>
+<span class="r-in"><span> replications <span class="op">=</span> <span class="fl">2</span><span class="op">)</span></span></span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> Loading required package: rbenchmark</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> test replications elapsed relative user.self sys.self user.child</span>
-<span class="r-out co"><span class="r-pr">#&gt;</span> 1 analytical 2 0.401 1.00 0.401 0.000 0</span>
-<span class="r-out co"><span class="r-pr">#&gt;</span> 2 deSolve 2 1.211 3.02 1.210 0.002 0</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> 1 analytical 2 0.445 1.000 0.444 0 0</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> 2 deSolve 2 0.693 1.557 0.692 0 0</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> sys.child</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 1 0</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 2 0</span>
-<span class="r-in"> <span class="va">DFOP_SFO</span> <span class="op">&lt;-</span> <span class="fu"><a href="mkinmod.html">mkinmod</a></span><span class="op">(</span></span>
-<span class="r-in"> parent <span class="op">=</span> <span class="fu"><a href="mkinmod.html">mkinsub</a></span><span class="op">(</span><span class="st">"DFOP"</span>, <span class="st">"m1"</span><span class="op">)</span>,</span>
-<span class="r-in"> m1 <span class="op">=</span> <span class="fu"><a href="mkinmod.html">mkinsub</a></span><span class="op">(</span><span class="st">"SFO"</span><span class="op">)</span><span class="op">)</span></span>
+<span class="r-in"><span> <span class="va">DFOP_SFO</span> <span class="op">&lt;-</span> <span class="fu"><a href="mkinmod.html">mkinmod</a></span><span class="op">(</span></span></span>
+<span class="r-in"><span> parent <span class="op">=</span> <span class="fu"><a href="mkinmod.html">mkinsub</a></span><span class="op">(</span><span class="st">"DFOP"</span>, <span class="st">"m1"</span><span class="op">)</span>,</span></span>
+<span class="r-in"><span> m1 <span class="op">=</span> <span class="fu"><a href="mkinmod.html">mkinsub</a></span><span class="op">(</span><span class="st">"SFO"</span><span class="op">)</span><span class="op">)</span></span></span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> Temporary DLL for differentials generated and loaded</span>
-<span class="r-in"> <span class="fu">benchmark</span><span class="op">(</span></span>
-<span class="r-in"> analytical <span class="op">=</span> <span class="fu"><a href="mkinfit.html">mkinfit</a></span><span class="op">(</span><span class="va">DFOP_SFO</span>, <span class="va">FOCUS_D</span>, solution_type <span class="op">=</span> <span class="st">"analytical"</span>, quiet <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span>,</span>
-<span class="r-in"> deSolve <span class="op">=</span> <span class="fu"><a href="mkinfit.html">mkinfit</a></span><span class="op">(</span><span class="va">DFOP_SFO</span>, <span class="va">FOCUS_D</span>, solution_type <span class="op">=</span> <span class="st">"deSolve"</span>, quiet <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span>,</span>
-<span class="r-in"> replications <span class="op">=</span> <span class="fl">2</span><span class="op">)</span></span>
+<span class="r-in"><span> <span class="fu"><a href="https://rdrr.io/pkg/rbenchmark/man/benchmark.html" class="external-link">benchmark</a></span><span class="op">(</span></span></span>
+<span class="r-in"><span> analytical <span class="op">=</span> <span class="fu"><a href="mkinfit.html">mkinfit</a></span><span class="op">(</span><span class="va">DFOP_SFO</span>, <span class="va">FOCUS_D</span>, solution_type <span class="op">=</span> <span class="st">"analytical"</span>, quiet <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span>,</span></span>
+<span class="r-in"><span> deSolve <span class="op">=</span> <span class="fu"><a href="mkinfit.html">mkinfit</a></span><span class="op">(</span><span class="va">DFOP_SFO</span>, <span class="va">FOCUS_D</span>, solution_type <span class="op">=</span> <span class="st">"deSolve"</span>, quiet <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span>,</span></span>
+<span class="r-in"><span> replications <span class="op">=</span> <span class="fl">2</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> test replications elapsed relative user.self sys.self user.child</span>
-<span class="r-out co"><span class="r-pr">#&gt;</span> 1 analytical 2 0.84 1.000 0.839 0.001 0</span>
-<span class="r-out co"><span class="r-pr">#&gt;</span> 2 deSolve 2 3.19 3.798 3.188 0.001 0</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> 1 analytical 2 0.871 1.000 0.871 0 0</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> 2 deSolve 2 1.519 1.744 1.519 0 0</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> sys.child</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 1 0</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 2 0</span>
-<span class="r-in"><span class="co"># }</span></span>
+<span class="r-in"><span><span class="co"># }</span></span></span>
</code></pre></div>
</div>
</div>
@@ -154,7 +165,7 @@
</div>
<div class="pkgdown">
- <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</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>

Contact - Imprint