diff options
Diffstat (limited to 'docs/reference/CAKE_export.html')
| -rw-r--r-- | docs/reference/CAKE_export.html | 73 |
1 files changed, 53 insertions, 20 deletions
diff --git a/docs/reference/CAKE_export.html b/docs/reference/CAKE_export.html index 4a0b599b..f1edaab2 100644 --- a/docs/reference/CAKE_export.html +++ b/docs/reference/CAKE_export.html @@ -18,7 +18,7 @@ specified as well."><!-- mathjax --><script src="https://cdnjs.cloudflare.com/aj </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> @@ -45,19 +45,25 @@ specified as well."><!-- mathjax --><script src="https://cdnjs.cloudflare.com/aj <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> @@ -89,21 +95,21 @@ specified as well.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">CAKE_export</span><span class="op">(</span> - <span class="va">ds</span>, - map <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>parent <span class="op">=</span> <span class="st">"Parent"</span><span class="op">)</span>, - links <span class="op">=</span> <span class="cn">NA</span>, - filename <span class="op">=</span> <span class="st">"CAKE_export.csf"</span>, - path <span class="op">=</span> <span class="st">"."</span>, - overwrite <span class="op">=</span> <span class="cn">FALSE</span>, - study <span class="op">=</span> <span class="st">"Degradinol aerobic soil degradation"</span>, - description <span class="op">=</span> <span class="st">""</span>, - time_unit <span class="op">=</span> <span class="st">"days"</span>, - res_unit <span class="op">=</span> <span class="st">"% AR"</span>, - comment <span class="op">=</span> <span class="st">""</span>, - date <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/Sys.time.html" class="external-link">Sys.Date</a></span><span class="op">(</span><span class="op">)</span>, - optimiser <span class="op">=</span> <span class="st">"IRLS"</span> -<span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">CAKE_export</span><span class="op">(</span></span> +<span> <span class="va">ds</span>,</span> +<span> map <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>parent <span class="op">=</span> <span class="st">"Parent"</span><span class="op">)</span>,</span> +<span> links <span class="op">=</span> <span class="cn">NA</span>,</span> +<span> filename <span class="op">=</span> <span class="st">"CAKE_export.csf"</span>,</span> +<span> path <span class="op">=</span> <span class="st">"."</span>,</span> +<span> overwrite <span class="op">=</span> <span class="cn">FALSE</span>,</span> +<span> study <span class="op">=</span> <span class="st">"Degradinol aerobic soil degradation"</span>,</span> +<span> description <span class="op">=</span> <span class="st">""</span>,</span> +<span> time_unit <span class="op">=</span> <span class="st">"days"</span>,</span> +<span> res_unit <span class="op">=</span> <span class="st">"% AR"</span>,</span> +<span> comment <span class="op">=</span> <span class="st">""</span>,</span> +<span> date <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/Sys.time.html" class="external-link">Sys.Date</a></span><span class="op">(</span><span class="op">)</span>,</span> +<span> optimiser <span class="op">=</span> <span class="st">"IRLS"</span></span> +<span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> @@ -111,38 +117,65 @@ specified as well.</p> <dl><dt>ds</dt> <dd><p>A named list of datasets in long format as compatible with <code><a href="mkinfit.html">mkinfit</a></code>.</p></dd> + + <dt>map</dt> <dd><p>A character vector with CAKE compartment names (Parent, A1, ...), named with the names used in the list of datasets.</p></dd> + + <dt>links</dt> <dd><p>An optional character vector of target compartments, named with the names of the source compartments. In order to make this easier, the names are used as in the datasets supplied.</p></dd> + + <dt>filename</dt> <dd><p>Where to write the result. Should end in .csf in order to be compatible with CAKE.</p></dd> + + <dt>path</dt> <dd><p>An optional path to the output file.</p></dd> + + <dt>overwrite</dt> <dd><p>If TRUE, existing files are overwritten.</p></dd> + + <dt>study</dt> <dd><p>The name of the study.</p></dd> + + <dt>description</dt> <dd><p>An optional description.</p></dd> + + <dt>time_unit</dt> <dd><p>The time unit for the residue data.</p></dd> + + <dt>res_unit</dt> <dd><p>The unit used for the residues.</p></dd> + + <dt>comment</dt> <dd><p>An optional comment.</p></dd> + + <dt>date</dt> <dd><p>The date of file creation.</p></dd> + + <dt>optimiser</dt> <dd><p>Can be OLS or IRLS.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>The function is called for its side effect.</p> + + +<p>The function is called for its side effect.</p> </div> <div id="author"> <h2>Author</h2> @@ -161,7 +194,7 @@ compatible with CAKE.</p></dd> </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> |