Update online docs

1 files changed, 29 insertions, 1 deletions

diff --git a/docs/reference/pfm_degradation.html b/docs/reference/pfm_degradation.html
index b4f3279..22d90ca 100644
--- a/docs/reference/pfm_degradation.html
+++ b/docs/reference/pfm_degradation.html
@@ -86,13 +86,21 @@ is calculated (SFO model).</p></dd>
 
 </dl></div>
     <div class="section level2">
+    <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
+    <p>A data frame containing the output times and the concentrations
+assuming initial concentrations of 1 for the parent and zero for
+metabolites, if any.</p>
+    </div>
+    <div class="section level2">
     <h2 id="author">Author<a class="anchor" aria-label="anchor" href="#author"></a></h2>
     <p>Johannes Ranke</p>
     </div>
 
     <div class="section level2">
     <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
-    <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/utils/head.html" class="external-link">head</a></span><span class="op">(</span><span class="fu">pfm_degradation</span><span class="op">(</span><span class="st">"SFO"</span>, DT50 <span class="op">=</span> <span class="fl">10</span><span class="op">)</span><span class="op">)</span></span></span>
+    <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="co"># Simple example of an SFO decline curve</span></span></span>
+<span class="r-in"><span><span class="va">sfo_out</span> <span class="op">&lt;-</span> <span class="fu">pfm_degradation</span><span class="op">(</span><span class="st">"SFO"</span>, DT50 <span class="op">=</span> <span class="fl">10</span><span class="op">)</span></span></span>
+<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/utils/head.html" class="external-link">head</a></span><span class="op">(</span><span class="va">sfo_out</span><span class="op">)</span></span></span>
 <span class="r-out co"><span class="r-pr">#&gt;</span>   time    parent</span>
 <span class="r-out co"><span class="r-pr">#&gt;</span> 0    0 1.0000000</span>
 <span class="r-out co"><span class="r-pr">#&gt;</span> 1    1 0.9330330</span>
@@ -100,6 +108,26 @@ is calculated (SFO model).</p></dd>
 <span class="r-out co"><span class="r-pr">#&gt;</span> 3    3 0.8122524</span>
 <span class="r-out co"><span class="r-pr">#&gt;</span> 4    4 0.7578583</span>
 <span class="r-out co"><span class="r-pr">#&gt;</span> 5    5 0.7071068</span>
+<span class="r-in"><span></span></span>
+<span class="r-in"><span><span class="co"># Fictive example with a metabolite where we first generate an SFO-SFO model</span></span></span>
+<span class="r-in"><span><span class="va">sfo_sfo</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://pkgdown.jrwb.de/mkin/reference/mkinmod.html" class="external-link">mkinmod</a></span><span class="op">(</span></span></span>
+<span class="r-in"><span>  parent <span class="op">=</span> <span class="fu"><a href="https://pkgdown.jrwb.de/mkin/reference/mkinmod.html" class="external-link">mkinsub</a></span><span class="op">(</span><span class="st">"SFO"</span>, to <span class="op">=</span> <span class="st">"metabolite"</span><span class="op">)</span>,</span></span>
+<span class="r-in"><span>  metabolite <span class="op">=</span> <span class="fu"><a href="https://pkgdown.jrwb.de/mkin/reference/mkinmod.html" class="external-link">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></span></span>
+<span class="r-in"><span><span class="va">sfo_sfo_out</span> <span class="op">&lt;-</span> <span class="fu">pfm_degradation</span><span class="op">(</span><span class="va">sfo_sfo</span>,</span></span>
+<span class="r-in"><span>  parms <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>k_parent <span class="op">=</span> <span class="fl">0.1</span>, f_parent_to_metabolite <span class="op">=</span> <span class="fl">0.5</span>, k_metabolite <span class="op">=</span> <span class="fl">0.02</span><span class="op">)</span><span class="op">)</span></span></span>
+<span class="r-in"><span></span></span>
+<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/graphics/plot.default.html" class="external-link">plot</a></span><span class="op">(</span></span></span>
+<span class="r-in"><span>  <span class="va">sfo_sfo_out</span><span class="op">[</span>, <span class="st">"time"</span><span class="op">]</span>,</span></span>
+<span class="r-in"><span>  <span class="va">sfo_sfo_out</span><span class="op">[</span>, <span class="st">"parent"</span><span class="op">]</span>, type <span class="op">=</span> <span class="st">"l"</span>,</span></span>
+<span class="r-in"><span>  xlab <span class="op">=</span> <span class="st">"Time"</span>, ylab <span class="op">=</span> <span class="st">"Relative concentration"</span>,</span></span>
+<span class="r-in"><span>  xlim <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="fl">0</span>, <span class="fl">100</span><span class="op">)</span><span class="op">)</span></span></span>
+<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/graphics/lines.html" class="external-link">lines</a></span><span class="op">(</span></span></span>
+<span class="r-in"><span>  <span class="va">sfo_sfo_out</span><span class="op">[</span>, <span class="st">"time"</span><span class="op">]</span>,</span></span>
+<span class="r-in"><span>  <span class="va">sfo_sfo_out</span><span class="op">[</span>, <span class="st">"metabolite"</span><span class="op">]</span>, lty <span class="op">=</span> <span class="fl">2</span><span class="op">)</span></span></span>
+<span class="r-plt img"><img src="pfm_degradation-1.png" alt="" width="700" height="433"></span>
+<span class="r-in"><span></span></span>
 </code></pre></div>
     </div>
   </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>