aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/print.mkinmod.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/print.mkinmod.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/print.mkinmod.html')
-rw-r--r--docs/reference/print.mkinmod.html23
1 files changed, 22 insertions, 1 deletions
diff --git a/docs/reference/print.mkinmod.html b/docs/reference/print.mkinmod.html
index 2034ea10..ab10b0b2 100644
--- a/docs/reference/print.mkinmod.html
+++ b/docs/reference/print.mkinmod.html
@@ -100,12 +100,33 @@
</dl>
+ <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
+ <pre class="examples"><div class='input'> <span class='no'>m_synth_SFO_lin</span> <span class='kw'>&lt;-</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>, <span class='kw'>to</span> <span class='kw'>=</span> <span class='st'>"M2"</span>),
+ <span class='kw'>M2</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'>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='fu'>print</span>(<span class='no'>m_synth_SFO_lin</span>)</div><div class='output co'>#&gt; &lt;mkinmod&gt; model generated with
+#&gt; Use of formation fractions $use_of_ff: max
+#&gt; Specification $spec:
+#&gt; $parent
+#&gt; $type: SFO; $to: M1; $sink: TRUE
+#&gt; $M1
+#&gt; $type: SFO; $to: M2; $sink: TRUE
+#&gt; $M2
+#&gt; $type: SFO; $sink: TRUE
+#&gt; Coefficient matrix $coefmat available
+#&gt; Compiled model $cf available
+#&gt; Differential equations:
+#&gt; d_parent/dt = - k_parent * parent
+#&gt; d_M1/dt = + f_parent_to_M1 * k_parent * parent - k_M1 * M1
+#&gt; d_M2/dt = + f_M1_to_M2 * k_M1 * M1 - k_M2 * M2</div></pre>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
<h2>Contents</h2>
<ul class="nav nav-pills nav-stacked">
<li><a href="#arguments">Arguments</a></li>
- </ul>
+
+ <li><a href="#examples">Examples</a></li>
+ </ul>
</div>
</div>

Contact - Imprint