aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/mkinerrmin.html
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2016-11-18 16:28:49 +0100
committerJohannes Ranke <jranke@uni-bremen.de>2016-11-18 16:28:49 +0100
commite7b2d16306b7d03cde66223c9b27abde928f9447 (patch)
tree85d650cfb8e071b00a1228566ec788dc1b477809 /docs/reference/mkinerrmin.html
parent8bdb67360502bd1a8eb5317d287b094510b4a02c (diff)
Improve examples for showing with pkgdown
- Use quiet= TRUE in dontrun sections - Use mkinsub in model definitions - Avoid \code{\link{}} in titles
Diffstat (limited to 'docs/reference/mkinerrmin.html')
-rw-r--r--docs/reference/mkinerrmin.html9
1 files changed, 4 insertions, 5 deletions
diff --git a/docs/reference/mkinerrmin.html b/docs/reference/mkinerrmin.html
index d212e3b2..a8557261 100644
--- a/docs/reference/mkinerrmin.html
+++ b/docs/reference/mkinerrmin.html
@@ -81,9 +81,8 @@
</div>
- <p>This function uses <code>optimize</code> in order to iteratively find the
-smallest relative error still resulting in passing the chi-squared test
-as defined in the FOCUS kinetics report from 2006.</p>
+ <p>This function finds the smallest relative error still resulting in passing the
+chi-squared test as defined in the FOCUS kinetics report from 2006.</p>
<pre><span class='fu'>mkinerrmin</span>(<span class='no'>fit</span>, <span class='kw'>alpha</span> <span class='kw'>=</span> <span class='fl'>0.05</span>)</pre>
@@ -120,8 +119,8 @@ as defined in the FOCUS kinetics report from 2006.</p>
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
- <pre class="examples"><div class='input'><span class='no'>SFO_SFO</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'>list</span>(<span class='kw'>type</span> <span class='kw'>=</span> <span class='st'>"SFO"</span>, <span class='kw'>to</span> <span class='kw'>=</span> <span class='st'>"m1"</span>),
- <span class='kw'>m1</span> <span class='kw'>=</span> <span class='fu'>list</span>(<span class='kw'>type</span> <span class='kw'>=</span> <span class='st'>"SFO"</span>),
+ <pre class="examples"><div class='input'><span class='no'>SFO_SFO</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='kw'>to</span> <span class='kw'>=</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='kw'>use_of_ff</span> <span class='kw'>=</span> <span class='st'>"max"</span>)</div><div class='output co'>#&gt; <span class='message'>Successfully compiled differential equation model from auto-generated C code.</span></div><div class='input'>
<span class='no'>fit_FOCUS_D</span> <span class='kw'>=</span> <span class='fu'><a href='mkinfit.html'>mkinfit</a></span>(<span class='no'>SFO_SFO</span>, <span class='no'>FOCUS_2006_D</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>)
<span class='fu'>round</span>(<span class='fu'>mkinerrmin</span>(<span class='no'>fit_FOCUS_D</span>), <span class='fl'>4</span>)</div><div class='output co'>#&gt; err.min n.optim df

Contact - Imprint