aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/mkinerrplot.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/reference/mkinerrplot.html')
-rw-r--r--docs/reference/mkinerrplot.html53
1 files changed, 26 insertions, 27 deletions
diff --git a/docs/reference/mkinerrplot.html b/docs/reference/mkinerrplot.html
index 4386673c..079a6708 100644
--- a/docs/reference/mkinerrplot.html
+++ b/docs/reference/mkinerrplot.html
@@ -37,11 +37,10 @@
<meta property="og:title" content="Function to plot squared residuals and the error model for an mkin object — mkinerrplot" />
<meta property="og:description" content="This function plots the squared residuals for the specified subset of the
- observed variables from an mkinfit object. In addition, one or more
- dashed line(s) show the fitted error model.
- A combined plot of the fitted model and this error model plot can be
- obtained with plot.mkinfit
- using the argument show_errplot = TRUE." />
+observed variables from an mkinfit object. In addition, one or more dashed
+line(s) show the fitted error model. A combined plot of the fitted model
+and this error model plot can be obtained with plot.mkinfit
+using the argument show_errplot = TRUE." />
<meta name="twitter:card" content="summary" />
@@ -139,21 +138,17 @@
<div class="ref-description">
<p>This function plots the squared residuals for the specified subset of the
- observed variables from an mkinfit object. In addition, one or more
- dashed line(s) show the fitted error model.
- A combined plot of the fitted model and this error model plot can be
- obtained with <code><a href='plot.mkinfit.html'>plot.mkinfit</a></code>
- using the argument <code>show_errplot = TRUE</code>.</p>
+observed variables from an mkinfit object. In addition, one or more dashed
+line(s) show the fitted error model. A combined plot of the fitted model
+and this error model plot can be obtained with <code><a href='plot.mkinfit.html'>plot.mkinfit</a></code>
+using the argument <code>show_errplot = TRUE</code>.</p>
</div>
- <pre class="usage"><span class='fu'>mkinerrplot</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'>predicted</span>)),
- <span class='kw'>xlab</span> <span class='kw'>=</span> <span class='st'>"Predicted"</span>, <span class='kw'>ylab</span> <span class='kw'>=</span> <span class='st'>"Squared residual"</span>,
- <span class='kw'>maxy</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'>mkinerrplot</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'>predicted</span>)), <span class='kw'>xlab</span> <span class='kw'>=</span> <span class='st'>"Predicted"</span>,
+ <span class='kw'>ylab</span> <span class='kw'>=</span> <span class='st'>"Squared residual"</span>, <span class='kw'>maxy</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">
@@ -164,8 +159,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>
@@ -182,7 +178,7 @@
<tr>
<th>maxy</th>
<td><p>Maximum value of the residuals. This is used for the scaling of
- the y axis and defaults to "auto".</p></td>
+the y axis and defaults to "auto".</p></td>
</tr>
<tr>
<th>legend</th>
@@ -190,8 +186,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>
@@ -213,15 +209,18 @@
<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='co'># \dontrun{</span>
+ <pre class="examples"><div class='input'>
+<span class='co'># \dontrun{</span>
<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'>error_model</span> <span class='kw'>=</span> <span class='st'>"tc"</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'>mkinerrplot</span>(<span class='no'>fit</span>)</div><div class='img'><img src='mkinerrplot-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">

Contact - Imprint