aboutsummaryrefslogtreecommitdiff
path: root/docs/dev/reference/mkinmod.html
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2023-02-17 22:48:18 +0100
committerJohannes Ranke <jranke@uni-bremen.de>2023-02-17 22:48:18 +0100
commitbcd98a1fa3cd2fb4b7105b7ec6c129ca18f872e8 (patch)
tree80ce30d68fb33fe92a0939e1f5be9790263909c1 /docs/dev/reference/mkinmod.html
parent5811ab93d856bb339a35eef2d23266fcb781cbe7 (diff)
Update online docs, fix bug that surfaced
Diffstat (limited to 'docs/dev/reference/mkinmod.html')
-rw-r--r--docs/dev/reference/mkinmod.html42
1 files changed, 31 insertions, 11 deletions
diff --git a/docs/dev/reference/mkinmod.html b/docs/dev/reference/mkinmod.html
index 145dee83..2bade85e 100644
--- a/docs/dev/reference/mkinmod.html
+++ b/docs/dev/reference/mkinmod.html
@@ -21,13 +21,13 @@ components."><meta name="robots" content="noindex"><!-- mathjax --><script src="
</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.2.2</span>
+ <span class="version label label-info" data-toggle="tooltip" data-placement="bottom" title="In-development version">1.2.3</span>
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav"><li>
- <a href="../reference/index.html">Functions and data</a>
+ <a href="../reference/index.html">Reference</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false">
@@ -38,6 +38,8 @@ components."><meta name="robots" content="noindex"><!-- mathjax --><script src="
<ul class="dropdown-menu" role="menu"><li>
<a href="../articles/mkin.html">Introduction to mkin</a>
</li>
+ <li class="divider">
+ <li class="dropdown-header">Example evaluations with (generalised) nonlinear least squares</li>
<li>
<a href="../articles/FOCUS_D.html">Example evaluation of FOCUS Example Dataset D</a>
</li>
@@ -45,22 +47,29 @@ components."><meta name="robots" content="noindex"><!-- mathjax --><script src="
<a href="../articles/FOCUS_L.html">Example evaluation of FOCUS Laboratory Data L1 to L3</a>
</li>
<li>
- <a href="../articles/web_only/dimethenamid_2018.html">Example evaluations of dimethenamid data from 2018 with nonlinear mixed-effects models</a>
+ <a href="../articles/web_only/FOCUS_Z.html">Example evaluation of FOCUS Example Dataset Z</a>
</li>
+ <li class="divider">
+ <li class="dropdown-header">Example evaluations with hierarchical models (nonlinear mixed-effects models)</li>
<li>
- <a href="../articles/web_only/multistart.html">Short demo of the multistart method</a>
+ <a href="../articles/prebuilt/2022_dmta_parent.html">Testing hierarchical parent degradation kinetics with residue data on dimethenamid and dimethenamid-P</a>
</li>
<li>
- <a href="../articles/web_only/compiled_models.html">Performance benefit by using compiled model definitions in mkin</a>
+ <a href="../articles/prebuilt/2022_dmta_pathway.html">Testing hierarchical pathway kinetics with residue data on dimethenamid and dimethenamid-P</a>
</li>
<li>
- <a href="../articles/web_only/FOCUS_Z.html">Example evaluation of FOCUS Example Dataset Z</a>
+ <a href="../articles/prebuilt/2022_cyan_pathway.html">Testing hierarchical pathway kinetics with residue data on cyantraniliprole</a>
</li>
<li>
- <a href="../articles/twa.html">Calculation of time weighted average concentrations with mkin</a>
+ <a href="../articles/web_only/dimethenamid_2018.html">Comparison of saemix and nlme evaluations of dimethenamid data from 2018</a>
</li>
<li>
- <a href="../articles/web_only/NAFTA_examples.html">Example evaluation of NAFTA SOP Attachment examples</a>
+ <a href="../articles/web_only/multistart.html">Short demo of the multistart method</a>
+ </li>
+ <li class="divider">
+ <li class="dropdown-header">Performance</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/benchmarks.html">Benchmark timings for mkin</a>
@@ -68,6 +77,14 @@ components."><meta name="robots" content="noindex"><!-- mathjax --><script src="
<li>
<a href="../articles/web_only/saem_benchmarks.html">Benchmark timings for saem.mmkin</a>
</li>
+ <li class="divider">
+ <li class="dropdown-header">Miscellaneous</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>
</ul></li>
<li>
<a href="../news/index.html">News</a>
@@ -169,7 +186,9 @@ applicable to give detailed information about the C function being built.</p></d
<dd><p>Directory where an DLL object, if generated internally by
<code><a href="https://rdrr.io/pkg/inline/man/cfunction.html" class="external-link">inline::cfunction()</a></code>, should be saved. The DLL will only be stored in a
permanent location for use in future sessions, if 'dll_dir' and 'name'
-are specified.</p></dd>
+are specified. This is helpful if fit objects are cached e.g. by knitr,
+as the cache remains functional across sessions if the DLL is stored in
+a user defined location.</p></dd>
<dt>unload</dt>
@@ -310,7 +329,7 @@ Evaluating and Calculating Degradation Kinetics in Environmental Media</p>
<span class="r-in"><span> parent <span class="op">=</span> <span class="fu">mkinsub</span><span class="op">(</span><span class="st">"SFO"</span>, <span class="st">"m1"</span>, full_name <span class="op">=</span> <span class="st">"Test compound"</span><span class="op">)</span>,</span></span>
<span class="r-in"><span> m1 <span class="op">=</span> <span class="fu">mkinsub</span><span class="op">(</span><span class="st">"SFO"</span>, full_name <span class="op">=</span> <span class="st">"Metabolite M1"</span><span class="op">)</span>,</span></span>
<span class="r-in"><span> name <span class="op">=</span> <span class="st">"SFO_SFO"</span>, dll_dir <span class="op">=</span> <span class="va">DLL_dir</span>, unload <span class="op">=</span> <span class="cn">TRUE</span>, overwrite <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span>
-<span class="r-msg co"><span class="r-pr">#&gt;</span> Copied DLL from /tmp/RtmpelWAOB/fileb43c31a25a86.so to /home/jranke/.local/share/mkin/SFO_SFO.so</span>
+<span class="r-msg co"><span class="r-pr">#&gt;</span> Copied DLL from /tmp/RtmpQitVfY/file9cd3235ec83e.so to /home/jranke/.local/share/mkin/SFO_SFO.so</span>
<span class="r-in"><span><span class="co"># Now we can save the model and restore it in a new session</span></span></span>
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/readRDS.html" class="external-link">saveRDS</a></span><span class="op">(</span><span class="va">SFO_SFO.2</span>, file <span class="op">=</span> <span class="st">"~/SFO_SFO.rds"</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="co"># Terminate the R session here if you would like to check, and then do</span></span></span>
@@ -318,6 +337,7 @@ Evaluating and Calculating Degradation Kinetics in Environmental Media</p>
<span class="r-in"><span><span class="va">SFO_SFO.3</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/readRDS.html" class="external-link">readRDS</a></span><span class="op">(</span><span class="st">"~/SFO_SFO.rds"</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="va">fit_sfo_sfo</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.3</span>, <span class="va">FOCUS_2006_D</span>, quiet <span class="op">=</span> <span class="cn">TRUE</span>, solution_type <span class="op">=</span> <span class="st">"deSolve"</span><span class="op">)</span></span></span>
<span class="r-wrn co"><span class="r-pr">#&gt;</span> <span class="warning">Warning: </span>Observations with value of zero were removed from the data</span>
+<span class="r-err co"><span class="r-pr">#&gt;</span> <span class="error">Error in is.loaded(initfunc, PACKAGE = dllname, type = ""):</span> invalid 'PACKAGE' argument</span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># Show details of creating the C function</span></span></span>
<span class="r-in"><span><span class="va">SFO_SFO</span> <span class="op">&lt;-</span> <span class="fu">mkinmod</span><span class="op">(</span></span></span>
@@ -363,7 +383,7 @@ Evaluating and Calculating Degradation Kinetics in Environmental Media</p>
<span class="r-out co"><span class="r-pr">#&gt;</span> })</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> return(predicted)</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> }</span>
-<span class="r-out co"><span class="r-pr">#&gt;</span> &lt;environment: 0x55555f013820&gt;</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> &lt;environment: 0x55558875dc90&gt;</span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># If we have several parallel metabolites</span></span></span>
<span class="r-in"><span><span class="co"># (compare tests/testthat/test_synthetic_data_for_UBA_2014.R)</span></span></span>

Contact - Imprint