aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/mkinresplot.html
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2019-11-04 23:55:09 +0100
committerJohannes Ranke <jranke@uni-bremen.de>2019-11-04 23:55:09 +0100
commitaa5aeeb5d55017774eff1066a495df59b97ca233 (patch)
treeef897c65a06c25e1bff3938782ef8ea431ff9f4a /docs/reference/mkinresplot.html
parent3410513f55b3f8b5c4331f4fb4487613d3a28208 (diff)
Static documentation rebuilt by pkgdown
Diffstat (limited to 'docs/reference/mkinresplot.html')
-rw-r--r--docs/reference/mkinresplot.html20
1 files changed, 13 insertions, 7 deletions
diff --git a/docs/reference/mkinresplot.html b/docs/reference/mkinresplot.html
index 1ac2cdbe..4429798b 100644
--- a/docs/reference/mkinresplot.html
+++ b/docs/reference/mkinresplot.html
@@ -72,7 +72,7 @@ argument show_residuals = TRUE." />
</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">0.9.49.6</span>
+ <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.9.49.8</span>
</span>
</div>
@@ -143,7 +143,8 @@ 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='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'>standardized</span> <span class='kw'>=</span> <span class='fl'>FALSE</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='fu'><a href='https://rdrr.io/r/base/ifelse.html'>ifelse</a></span>(<span class='no'>standardized</span>, <span class='st'>"Standardized residual"</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>
@@ -165,13 +166,17 @@ the model</p></td>
<td><p>plot range in x direction.</p></td>
</tr>
<tr>
+ <th>standardized</th>
+ <td><p>Should the residuals be standardized by dividing by the
+standard deviation given by the error model of the fit?</p></td>
+ </tr>
+ <tr>
<th>xlab</th>
- <td><p>Label for the x axis. Defaults to "Time [days]".</p></td>
+ <td><p>Label for the x axis.</p></td>
</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.</p></td>
</tr>
<tr>
<th>maxabs</th>
@@ -180,7 +185,7 @@ scaling of the y axis and defaults to "auto".</p></td>
</tr>
<tr>
<th>legend</th>
- <td><p>Should a legend be plotted? Defaults to "TRUE".</p></td>
+ <td><p>Should a legend be plotted?</p></td>
</tr>
<tr>
<th>lpos</th>
@@ -212,7 +217,8 @@ be passed on to <code><a href='https://rdrr.io/r/graphics/legend.html'>legend</a
<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>
+ lines of the mkinfit object, and <code><a href='plot.mkinfit.html'>plot_res</a></code> for a function
+ combining the plot of the fit and the residual plot.</p></div>
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
<pre class="examples"><div class='input'>

Contact - Imprint