aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/plot.mmkin.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/reference/plot.mmkin.html')
-rw-r--r--docs/reference/plot.mmkin.html76
1 files changed, 43 insertions, 33 deletions
diff --git a/docs/reference/plot.mmkin.html b/docs/reference/plot.mmkin.html
index 9a11108f..8b68cfae 100644
--- a/docs/reference/plot.mmkin.html
+++ b/docs/reference/plot.mmkin.html
@@ -6,13 +6,16 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>Plot model fits (observed and fitted) and the residuals for a row or column of an mmkin object — plot.mmkin • mkin</title>
+<title>Plot model fits (observed and fitted) and the residuals for a row or column
+of an mmkin object — plot.mmkin • 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,17 +35,17 @@
-<meta property="og:title" content="Plot model fits (observed and fitted) and the residuals for a row or column of an mmkin object — plot.mmkin" />
-<meta property="og:description" content="When x is a row selected from an mmkin object ([.mmkin), the same model
- fitted for at least one dataset is shown. When it is a column, the fit of at least one model
- to the same dataset is shown.
-If the current plot device is a tikz device,
- then latex is being used for the formatting of the chi2 error level." />
+<meta property="og:title" content="Plot model fits (observed and fitted) and the residuals for a row or column
+of an mmkin object — plot.mmkin" />
+<meta property="og:description" content="When x is a row selected from an mmkin object ([.mmkin), the
+same model fitted for at least one dataset is shown. When it is a column,
+the fit of at least one model to the same dataset is shown." />
<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>
@@ -113,7 +116,6 @@ If the current plot device is a tikz device,
<a href="../news/index.html">News</a>
</li>
</ul>
-
<ul class="nav navbar-nav navbar-right">
</ul>
@@ -129,32 +131,31 @@ If the current plot device is a tikz device,
<div class="row">
<div class="col-md-9 contents">
<div class="page-header">
- <h1>Plot model fits (observed and fitted) and the residuals for a row or column of an mmkin object</h1>
+ <h1>Plot model fits (observed and fitted) and the residuals for a row or column
+of an mmkin object</h1>
<div class="hidden name"><code>plot.mmkin.Rd</code></div>
</div>
<div class="ref-description">
-
- <p>When x is a row selected from an mmkin object (<code><a href='Extract.mmkin.html'>[.mmkin</a></code>), the same model
- fitted for at least one dataset is shown. When it is a column, the fit of at least one model
- to the same dataset is shown.</p>
-<p>If the current plot device is a <code><a href='https://rdrr.io/pkg/tikzDevice/man/tikz.html'>tikz</a></code> device,
- then latex is being used for the formatting of the chi2 error level.</p>
-
+ <p>When x is a row selected from an mmkin object (<code><a href='Extract.mmkin.html'>[.mmkin</a></code>), the
+same model fitted for at least one dataset is shown. When it is a column,
+the fit of at least one model to the same dataset is shown.</p>
</div>
<pre class="usage"><span class='co'># S3 method for mmkin</span>
<span class='fu'><a href='https://rdrr.io/r/graphics/plot.html'>plot</a></span>(<span class='no'>x</span>, <span class='kw'>main</span> <span class='kw'>=</span> <span class='st'>"auto"</span>, <span class='kw'>legends</span> <span class='kw'>=</span> <span class='fl'>1</span>,
- <span class='kw'>resplot</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='st'>"time"</span>, <span class='st'>"errmod"</span>), <span class='kw'>show_errmin</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>errmin_var</span> <span class='kw'>=</span> <span class='st'>"All data"</span>,
- <span class='kw'>errmin_digits</span> <span class='kw'>=</span> <span class='fl'>3</span>, <span class='kw'>cex</span> <span class='kw'>=</span> <span class='fl'>0.7</span>, <span class='kw'>rel.height.middle</span> <span class='kw'>=</span> <span class='fl'>0.9</span>, <span class='no'>...</span>)</pre>
-
+ <span class='kw'>resplot</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='st'>"time"</span>, <span class='st'>"errmod"</span>), <span class='kw'>show_errmin</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>,
+ <span class='kw'>errmin_var</span> <span class='kw'>=</span> <span class='st'>"All data"</span>, <span class='kw'>errmin_digits</span> <span class='kw'>=</span> <span class='fl'>3</span>, <span class='kw'>cex</span> <span class='kw'>=</span> <span class='fl'>0.7</span>,
+ <span class='kw'>rel.height.middle</span> <span class='kw'>=</span> <span class='fl'>0.9</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>
<tr>
<th>x</th>
- <td><p>An object of class <code><a href='mmkin.html'>mmkin</a></code>, with either one row or one column.</p></td>
+ <td><p>An object of class <code><a href='mmkin.html'>mmkin</a></code>, with either one row or one
+column.</p></td>
</tr>
<tr>
<th>main</th>
@@ -166,21 +167,24 @@ If the current plot device is a tikz device,
</tr>
<tr>
<th>resplot</th>
- <td><p>Should the residuals plotted against time, using <code><a href='mkinresplot.html'>mkinresplot</a></code>,
- or as squared residuals against predicted values, with the error model,
- using <code><a href='mkinerrplot.html'>mkinerrplot</a></code>.</p></td>
+ <td><p>Should the residuals plotted against time, using
+<code><a href='mkinresplot.html'>mkinresplot</a></code>, or as squared residuals against predicted
+values, with the error model, using <code><a href='mkinerrplot.html'>mkinerrplot</a></code>.</p></td>
</tr>
<tr>
<th>show_errmin</th>
- <td><p>Should the chi2 error level be shown on top of the plots to the left?</p></td>
+ <td><p>Should the chi2 error level be shown on top of the plots
+to the left?</p></td>
</tr>
<tr>
<th>errmin_var</th>
- <td><p>The variable for which the FOCUS chi2 error value should be shown.</p></td>
+ <td><p>The variable for which the FOCUS chi2 error value should
+be shown.</p></td>
</tr>
<tr>
<th>errmin_digits</th>
- <td><p>The number of significant digits for rounding the FOCUS chi2 error percentage.</p></td>
+ <td><p>The number of significant digits for rounding the FOCUS
+chi2 error percentage.</p></td>
</tr>
<tr>
<th>cex</th>
@@ -188,21 +192,27 @@ If the current plot device is a tikz device,
</tr>
<tr>
<th>rel.height.middle</th>
- <td><p>The relative height of the middle plot, if more than two rows of plots are shown.</p></td>
+ <td><p>The relative height of the middle plot, if more
+than two rows of plots are shown.</p></td>
</tr>
<tr>
<th>...</th>
- <td><p>Further arguments passed to <code><a href='plot.mkinfit.html'>plot.mkinfit</a></code> and <code><a href='mkinresplot.html'>mkinresplot</a></code>.</p></td>
+ <td><p>Further arguments passed to <code><a href='plot.mkinfit.html'>plot.mkinfit</a></code> and
+<code><a href='mkinresplot.html'>mkinresplot</a></code>.</p></td>
</tr>
</table>
-
+
<h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
<p>The function is called for its side effect.</p>
-
+ <h2 class="hasAnchor" id="details"><a class="anchor" href="#details"></a>Details</h2>
+
+ <p>If the current plot device is a <code><a href='https://rdrr.io/pkg/tikzDevice/man/tikz.html'>tikz</a></code> device, then
+latex is being used for the formatting of the chi2 error level.</p>
<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='co'># Only use one core not to offend CRAN checks</span>
<span class='no'>fits</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='mmkin.html'>mmkin</a></span>(<span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='st'>"FOMC"</span>, <span class='st'>"HS"</span>),
<span class='fu'><a href='https://rdrr.io/r/base/list.html'>list</a></span>(<span class='st'>"FOCUS B"</span> <span class='kw'>=</span> <span class='no'>FOCUS_2006_B</span>, <span class='st'>"FOCUS C"</span> <span class='kw'>=</span> <span class='no'>FOCUS_2006_C</span>), <span class='co'># named list for titles</span>
@@ -214,15 +224,15 @@ If the current plot device is a tikz device,
<span class='fu'><a href='https://rdrr.io/r/graphics/plot.html'>plot</a></span>(<span class='no'>fits</span>[<span class='st'>"FOMC"</span>, <span class='st'>"FOCUS C"</span>]) <span class='co'># same as plot(fits[1, 2])</span></div><div class='img'><img src='plot.mmkin-3.png' alt='' width='700' height='433' /></div><div class='input'>
<span class='co'># Show the error models</span>
<span class='fu'><a href='https://rdrr.io/r/graphics/plot.html'>plot</a></span>(<span class='no'>fits</span>[<span class='st'>"FOMC"</span>, ], <span class='kw'>resplot</span> <span class='kw'>=</span> <span class='st'>"errmod"</span>)</div><div class='img'><img src='plot.mmkin-4.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="#details">Details</a></li>
<li><a href="#examples">Examples</a></li>
</ul>

Contact - Imprint