aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/mkinresplot.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/reference/mkinresplot.html')
-rw-r--r--docs/reference/mkinresplot.html72
1 files changed, 34 insertions, 38 deletions
diff --git a/docs/reference/mkinresplot.html b/docs/reference/mkinresplot.html
index eea5b218..1ac2cdbe 100644
--- a/docs/reference/mkinresplot.html
+++ b/docs/reference/mkinresplot.html
@@ -8,11 +8,13 @@
<title>Function to plot residuals stored in an mkin object — mkinresplot • mkin</title>
+
<!-- jquery -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
<!-- Bootstrap -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha256-916EbMg70RQy9LHiGkXzG8hSg9EdNy97GazNG/aiY1w=" crossorigin="anonymous" />
+
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script>
<!-- Font Awesome icons -->
@@ -32,16 +34,17 @@
-<meta property="og:title" content="Function to plot residuals stored in an mkin object — mkinresplot" />
-<meta property="og:description" content="This function plots the residuals for the specified subset of the
- observed variables from an mkinfit object. A combined plot of the fitted
- model and the residuals can be obtained using plot.mkinfit
- using the argument show_residuals = TRUE." />
+<meta property="og:title" content="Function to plot residuals stored in an mkin object — mkinresplot" />
+<meta property="og:description" content="This function plots the residuals for the specified subset of the observed
+variables from an mkinfit object. A combined plot of the fitted model and
+the residuals can be obtained using plot.mkinfit using the
+argument show_residuals = TRUE." />
<meta name="twitter:card" content="summary" />
+
<!-- mathjax -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script>
@@ -112,7 +115,6 @@
<a href="../news/index.html">News</a>
</li>
</ul>
-
<ul class="nav navbar-nav navbar-right">
</ul>
@@ -134,23 +136,17 @@
</div>
<div class="ref-description">
-
- <p>This function plots the residuals for the specified subset of the
- observed variables from an mkinfit object. A combined plot of the fitted
- model and the residuals can be obtained using <code><a href='plot.mkinfit.html'>plot.mkinfit</a></code>
- using the argument <code>show_residuals = TRUE</code>.</p>
-
+ <p>This function plots the residuals for the specified subset of the observed
+variables from an mkinfit object. A combined plot of the fitted model and
+the residuals can be obtained using <code><a href='plot.mkinfit.html'>plot.mkinfit</a></code> using the
+argument <code>show_residuals = TRUE</code>.</p>
</div>
- <pre class="usage"><span class='fu'>mkinresplot</span>(<span class='no'>object</span>,
- <span class='kw'>obs_vars</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/names.html'>names</a></span>(<span class='no'>object</span>$<span class='no'>mkinmod</span>$<span class='no'>map</span>),
- <span class='kw'>xlim</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='fl'>0</span>, <span class='fl'>1.1</span> * <span class='fu'><a href='https://rdrr.io/r/base/Extremes.html'>max</a></span>(<span class='no'>object</span>$<span class='no'>data</span>$<span class='no'>time</span>)),
- <span class='kw'>xlab</span> <span class='kw'>=</span> <span class='st'>"Time"</span>, <span class='kw'>ylab</span> <span class='kw'>=</span> <span class='st'>"Residual"</span>,
- <span class='kw'>maxabs</span> <span class='kw'>=</span> <span class='st'>"auto"</span>, <span class='kw'>legend</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>lpos</span> <span class='kw'>=</span> <span class='st'>"topright"</span>,
- <span class='kw'>col_obs</span> <span class='kw'>=</span> <span class='st'>"auto"</span>, <span class='kw'>pch_obs</span> <span class='kw'>=</span> <span class='st'>"auto"</span>,
- <span class='kw'>frame</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>,
- <span class='no'>...</span>)</pre>
-
+ <pre class="usage"><span class='fu'>mkinresplot</span>(<span class='no'>object</span>, <span class='kw'>obs_vars</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/names.html'>names</a></span>(<span class='no'>object</span>$<span class='no'>mkinmod</span>$<span class='no'>map</span>), <span class='kw'>xlim</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='fl'>0</span>,
+ <span class='fl'>1.1</span> * <span class='fu'><a href='https://rdrr.io/r/base/Extremes.html'>max</a></span>(<span class='no'>object</span>$<span class='no'>data</span>$<span class='no'>time</span>)), <span class='kw'>xlab</span> <span class='kw'>=</span> <span class='st'>"Time"</span>, <span class='kw'>ylab</span> <span class='kw'>=</span> <span class='st'>"Residual"</span>,
+ <span class='kw'>maxabs</span> <span class='kw'>=</span> <span class='st'>"auto"</span>, <span class='kw'>legend</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>lpos</span> <span class='kw'>=</span> <span class='st'>"topright"</span>,
+ <span class='kw'>col_obs</span> <span class='kw'>=</span> <span class='st'>"auto"</span>, <span class='kw'>pch_obs</span> <span class='kw'>=</span> <span class='st'>"auto"</span>, <span class='kw'>frame</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='no'>...</span>)</pre>
+
<h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
<table class="ref-arguments">
<colgroup><col class="name" /><col class="desc" /></colgroup>
@@ -160,8 +156,9 @@
</tr>
<tr>
<th>obs_vars</th>
- <td><p>A character vector of names of the observed variables for which residuals
- should be plotted. Defaults to all observed variables in the model</p></td>
+ <td><p>A character vector of names of the observed variables for
+which residuals should be plotted. Defaults to all observed variables in
+the model</p></td>
</tr>
<tr>
<th>xlim</th>
@@ -173,12 +170,13 @@
</tr>
<tr>
<th>ylab</th>
- <td><p>Label for the y axis. Defaults to "Residual [% of applied radioactivity]".</p></td>
+ <td><p>Label for the y axis. Defaults to "Residual [% of applied
+radioactivity]".</p></td>
</tr>
<tr>
<th>maxabs</th>
- <td><p>Maximum absolute value of the residuals. This is used for the scaling of
- the y axis and defaults to "auto".</p></td>
+ <td><p>Maximum absolute value of the residuals. This is used for the
+scaling of the y axis and defaults to "auto".</p></td>
</tr>
<tr>
<th>legend</th>
@@ -186,8 +184,8 @@
</tr>
<tr>
<th>lpos</th>
- <td><p>Where should the legend be placed? Default is "topright". Will be passed on to
- <code><a href='https://rdrr.io/r/graphics/legend.html'>legend</a></code>.</p></td>
+ <td><p>Where should the legend be placed? Default is "topright". Will
+be passed on to <code><a href='https://rdrr.io/r/graphics/legend.html'>legend</a></code>.</p></td>
</tr>
<tr>
<th>col_obs</th>
@@ -206,29 +204,27 @@
<td><p>further arguments passed to <code><a href='https://rdrr.io/r/graphics/plot.html'>plot</a></code>.</p></td>
</tr>
</table>
-
+
<h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
- <p>Nothing is returned by this function, as it is called for its side effect, namely to produce a plot.</p>
-
+ <p>Nothing is returned by this function, as it is called for its side
+ effect, namely to produce a plot.</p>
<h2 class="hasAnchor" id="see-also"><a class="anchor" href="#see-also"></a>See also</h2>
- <div class='dont-index'><p><code><a href='mkinplot.html'>mkinplot</a></code>, for a way to plot the data and the fitted lines of the
- mkinfit object.</p></div>
-
+ <div class='dont-index'><p><code><a href='mkinplot.html'>mkinplot</a></code>, for a way to plot the data and the fitted
+ lines of the mkinfit object.</p></div>
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
- <pre class="examples"><div class='input'><span class='no'>model</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'><a href='mkinsub.html'>mkinsub</a></span>(<span class='st'>"SFO"</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>))</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</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='mkinfit.html'>mkinfit</a></span>(<span class='no'>model</span>, <span class='no'>FOCUS_2006_D</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>)</div><div class='output co'>#&gt; <span class='warning'>Warning: Observations with value of zero were removed from the data</span></div><div class='input'><span class='fu'>mkinresplot</span>(<span class='no'>fit</span>, <span class='st'>"m1"</span>)</div><div class='img'><img src='mkinresplot-1.png' alt='' width='700' height='433' /></div></pre>
+ <pre class="examples"><div class='input'>
+<span class='no'>model</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'><a href='mkinsub.html'>mkinsub</a></span>(<span class='st'>"SFO"</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>))</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</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='mkinfit.html'>mkinfit</a></span>(<span class='no'>model</span>, <span class='no'>FOCUS_2006_D</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>)</div><div class='output co'>#&gt; <span class='warning'>Warning: Observations with value of zero were removed from the data</span></div><div class='input'><span class='fu'>mkinresplot</span>(<span class='no'>fit</span>, <span class='st'>"m1"</span>)</div><div class='img'><img src='mkinresplot-1.png' alt='' width='700' height='433' /></div><div class='input'>
+</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>
-
<li><a href="#value">Value</a></li>
-
<li><a href="#see-also">See also</a></li>
-
<li><a href="#examples">Examples</a></li>
</ul>

Contact - Imprint