diff options
Diffstat (limited to 'docs/plot.mmkin.html')
| -rw-r--r-- | docs/plot.mmkin.html | 158 |
1 files changed, 0 insertions, 158 deletions
diff --git a/docs/plot.mmkin.html b/docs/plot.mmkin.html deleted file mode 100644 index 24b0d60c..00000000 --- a/docs/plot.mmkin.html +++ /dev/null @@ -1,158 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <head> - <meta charset="utf-8"> -<title>plot.mmkin. mkin 0.9.44.9000</title> -<meta name="viewport" content="width=device-width, initial-scale=1.0"> -<meta name="author" content=" - Johannes Ranke -"> - -<link href="css/bootstrap.css" rel="stylesheet"> -<link href="css/bootstrap-responsive.css" rel="stylesheet"> -<link href="css/highlight.css" rel="stylesheet"> -<link href="css/staticdocs.css" rel="stylesheet"> - -<!--[if lt IE 9]> - <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> -<![endif]--> - -<script type="text/x-mathjax-config"> - MathJax.Hub.Config({ - tex2jax: { - inlineMath: [ ['$','$'], ["\\(","\\)"] ], - processEscapes: true - } - }); -</script> -<script type="text/javascript" - src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"> -</script> - </head> - - <body> - <div class="navbar"> - <div class="navbar-inner"> - <div class="container"> - <a class="brand" href="index.html">mkin 0.9.44.9000</a> - <div class="nav"> - <ul class="nav"> - <li><a href="index.html">Home</a></li> - <li><a href="reference.html">Reference</a></li> - </ul> - </div> - </div> - </div> -</div> - - - <div class="container"> - <header> - - </header> - - <h1> - Plot model fits (observed and fitted) and the residuals for a row or column of an mmkin object -</h1> - -<div class="row"> - <div class="span8"> - <h2>Usage</h2> - <pre><span class="comment"># S3 method for mmkin</span> -<span class="functioncall"><a href='http://www.rdocumentation.org/packages/graphics/topics/plot'>plot</a></span><span class="keyword">(</span><span class="symbol">x</span><span class="keyword">,</span> <span class="argument">main</span> <span class="argument">=</span> <span class="string">"auto"</span><span class="keyword">,</span> <span class="argument">legends</span> <span class="argument">=</span> <span class="number">1</span><span class="keyword">,</span> <span class="argument">errmin_var</span> <span class="argument">=</span> <span class="string">"All data"</span><span class="keyword">,</span> <span class="argument">errmin_digits</span> <span class="argument">=</span> <span class="number">3</span><span class="keyword">,</span> - <span class="argument">cex</span> <span class="argument">=</span> <span class="number">0.7</span><span class="keyword">,</span> <span class="argument">rel.height.middle</span> <span class="argument">=</span> <span class="number">0.9</span><span class="keyword">,</span> <span class="symbol">...</span><span class="keyword">)</span></pre> - - <h2>Arguments</h2> - <dl> - <dt>x</dt> - <dd> - An object of class <code><a href='mmkin.html'>mmkin</a></code>, with either one row or one column. -</dd> - <dt>main</dt> - <dd> - The main title placed on the outer margin of the plot. -</dd> - <dt>legends</dt> - <dd> - An index for the fits for which legends should be shown. -</dd> - <dt>errmin_var</dt> - <dd> - The variable for which the FOCUS chi2 error value should be shown. -</dd> - <dt>errmin_digits</dt> - <dd> - The number of significant digits for rounding the FOCUS chi2 error percentage. -</dd> - <dt>cex</dt> - <dd> - Passed to the plot functions and <code><a href='http://www.rdocumentation.org/packages/graphics/topics/mtext'>mtext</a></code>. -</dd> - <dt>rel.height.middle</dt> - <dd> - The relative height of the middle plot, if more than two rows of plots are shown. -</dd> - <dt>...</dt> - <dd> - Further arguments passed to <code><a href='plot.mkinfit.html'>plot.mkinfit</a></code> and <code><a href='mkinresplot.html'>mkinresplot</a></code>. -</dd> - </dl> - - <div class="Description"> - <h2>Description</h2> - - <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> - - <div class="Value"> - <h2>Value</h2> - - <p><dl> - The function is called for its side effect. -</dl></p> - - </div> - - <h2 id="examples">Examples</h2> - <pre class="examples"><div class='input'> <span class="comment"># Only use one core not to offend CRAN checks, use Levenberg-Marquardt for speed</span> - <span class="symbol">fits</span> <span class="assignement"><-</span> <span class="functioncall"><a href='mmkin.html'>mmkin</a></span><span class="keyword">(</span><span class="functioncall"><a href='http://www.rdocumentation.org/packages/base/topics/c'>c</a></span><span class="keyword">(</span><span class="string">"FOMC"</span><span class="keyword">,</span> <span class="string">"HS"</span><span class="keyword">)</span><span class="keyword">,</span> <span class="functioncall"><a href='http://www.rdocumentation.org/packages/base/topics/list'>list</a></span><span class="keyword">(</span><span class="string">"FOCUS B"</span> <span class="argument">=</span> <span class="symbol">FOCUS_2006_B</span><span class="keyword">,</span> <span class="string">"FOCUS C"</span> <span class="argument">=</span> <span class="symbol">FOCUS_2006_C</span><span class="keyword">)</span><span class="keyword">,</span> - <span class="argument">cores</span> <span class="argument">=</span> <span class="number">1</span><span class="keyword">,</span> <span class="argument">quiet</span> <span class="argument">=</span> <span class="number">TRUE</span><span class="keyword">,</span> <span class="argument">method.modFit</span> <span class="argument">=</span> <span class="string">"Marq"</span><span class="keyword">)</span> - <span class="functioncall"><a href='http://www.rdocumentation.org/packages/graphics/topics/plot'>plot</a></span><span class="keyword">(</span><span class="symbol">fits</span><span class="keyword">[</span><span class="keyword">,</span> <span class="string">"FOCUS C"</span><span class="keyword">]</span><span class="keyword">)</span></div> -<p><img src='plot.mmkin-2.png' alt='' width='540' height='400' /></p> -<div class='input'> <span class="functioncall"><a href='http://www.rdocumentation.org/packages/graphics/topics/plot'>plot</a></span><span class="keyword">(</span><span class="symbol">fits</span><span class="keyword">[</span><span class="string">"FOMC"</span><span class="keyword">,</span> <span class="keyword">]</span><span class="keyword">)</span></div> -<p><img src='plot.mmkin-4.png' alt='' width='540' height='400' /></p> -<div class='input'> - <span class="comment"># We can also plot a single fit, if we like the way mmkin works, but then the plot </span> - <span class="comment"># height should be smaller than the plot width (this is not possible for the html pages</span> - <span class="comment"># generated by staticdocs, as far as I know).</span> - <span class="functioncall"><a href='http://www.rdocumentation.org/packages/graphics/topics/plot'>plot</a></span><span class="keyword">(</span><span class="symbol">fits</span><span class="keyword">[</span><span class="string">"FOMC"</span><span class="keyword">,</span> <span class="string">"FOCUS C"</span><span class="keyword">]</span><span class="keyword">)</span> <span class="comment"># same as plot(fits[1, 2])</span></div> -<p><img src='plot.mmkin-6.png' alt='' width='540' height='400' /></p></pre> - </div> - <div class="span4 sidebar"> - <!-- <ul> - <li>plot.mmkin</li> - </ul> - <ul> - - </ul> --> - - - - <h2>Author</h2> - - Johannes Ranke - - - </div> -</div> - - <footer> - <p class="pull-right"><a href="#">Back to top</a></p> -<p>Built by <a href="https://github.com/hadley/staticdocs">staticdocs</a>. Styled with <a href="https://getbootstrap.com/2.0.4/">bootstrap</a>.</p> - </footer> - </div> - </body> -</html>
\ No newline at end of file |