Static documentation rebuilt by pkgdown::build_site()

author: Johannes Ranke <jranke@uni-bremen.de> 2016-10-06 09:19:21 +0200
committer: Johannes Ranke <jranke@uni-bremen.de> 2016-10-06 09:19:21 +0200
commit: 38f9e15f0c972c1516ae737a2bca8d7789581bbd (patch)
tree: 724c9dc19901f24f427757ac81001f07bf298024 /docs/reference/plot.mmkin.html
parent: ec1487f0f2cef32d44b0c6ce94a6f1b4f65a79d3 (diff)
1 files changed, 156 insertions, 0 deletions
diff --git a/docs/reference/plot.mmkin.html b/docs/reference/plot.mmkin.html
new file mode 100644
index 00000000..358da679
--- /dev/null
+++ b/docs/reference/plot.mmkin.html
@@ -0,0 +1,156 @@
+<!-- Generated by pkgdown: do not edit by hand -->
+<!DOCTYPE html>
+<html>
+  <head>
+  <meta charset="utf-8">
+<meta http-equiv="X-UA-Compatible" content="IE=edge">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+<title>plot.mmkin. mkin</title>
+
+<!-- jquery -->
+<script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script>
+
+<!-- Bootstrap -->
+<link href="https://maxcdn.bootstrapcdn.com/bootswatch/3.3.7/cerulean/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous">
+
+<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
+
+<!-- Font Awesome icons -->
+<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-T8Gy5hrqNKT+hzMclPo118YTQO6cYprQmhrYwIiQ/3axmI1hQomh7Ud2hPOy8SP1" crossorigin="anonymous">
+
+
+<!-- pkgdown -->
+<link href="../pkgdown.css" rel="stylesheet">
+<script src="../pkgdown.js"></script>
+
+<!-- mathjax -->
+<script src='https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script>
+
+<!--[if lt IE 9]>
+<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
+<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
+<![endif]-->
+  </head>
+
+  <body>
+    <div class="container">
+      <header>
+      
+<div class="navbar navbar-default  navbar-fixed-top" role="navigation">
+  <div class="container">
+    <div class="navbar-header">
+      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+      </button>
+      <a class="navbar-brand" href="../index.html">mkin</a>
+    </div>
+    <div id="navbar" class="navbar-collapse collapse">
+      <ul class="nav navbar-nav">
+        <li>
+  <a href="../index.html">Home</a>
+</li>
+<li>
+  <a href="../reference/index.html">Reference</a>
+</li>
+      </ul>
+      <ul class="nav navbar-nav navbar-right">
+        <li>
+  <a href="https://github.com/jranke/mkin">
+    <span class="fa fa-github fa-lg"></span>
+     
+  </a>
+</li>
+      </ul>
+    </div><!--/.nav-collapse -->
+  </div><!--/.container -->
+</div><!--/.navbar -->
+      
+      </header>
+
+      <div class="page-header">
+  <h1>
+</h1>
+</div>
+
+<div class="row">
+  <div class="col-md-9">
+    
+    <p>When x is a row selected from an mmkin object (<code>[.mmkin</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>
+    
+
+    <pre><span class='co'># S3 method for mmkin</span>
+<span class='fu'>plot</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'>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>Arguments</h2>
+    <dl class="dl-horizontal">
+      <dt>x</dt>
+      <dd>
+    An object of class <code>mmkin</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>mtext</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>&amp;#8230;</dt>
+      <dd>
+    Further arguments passed to <code>plot.mkinfit</code> and <code>mkinresplot</code>.
+</dd>
+    </dl>
+    
+    <div class="Value">
+      <h2>Value</h2>
+
+      <p>The function is called for its side effect.</p>
+    </div>
+    
+    <h2 id="examples">Examples</h2>
+    <pre class="examples"><div class='input'>  <span class='co'># Only use one core not to offend CRAN checks, use Levenberg-Marquardt for speed</span>
+  <span class='no'>fits</span> <span class='kw'>&lt;-</span> <span class='fu'>mmkin</span>(<span class='fu'>c</span>(<span class='st'>"FOMC"</span>, <span class='st'>"HS"</span>), <span class='fu'>list</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='kw'>cores</span> <span class='kw'>=</span> <span class='fl'>1</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>method.modFit</span> <span class='kw'>=</span> <span class='st'>"Marq"</span>)
+  <span class='fu'>plot</span>(<span class='no'>fits</span>[, <span class='st'>"FOCUS C"</span>])</div><img src='unknown-2.png' alt='' width='540' height='400' /><div class='input'>  <span class='fu'>plot</span>(<span class='no'>fits</span>[<span class='st'>"FOMC"</span>, ])</div><img src='unknown-4.png' alt='' width='540' height='400' /><div class='input'>
+  <span class='co'># We can also plot a single fit, if we like the way mmkin works, but then the plot </span>
+  <span class='co'># height should be smaller than the plot width (this is not possible for the html pages</span>
+  <span class='co'># generated by staticdocs, as far as I know).</span>
+  <span class='fu'>plot</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><img src='unknown-6.png' alt='' width='540' height='400' /></pre>
+  </div>
+  <div class="col-md-3">
+    <h2>Author</h2>
+    
+  Johannes Ranke
+
+  </div>
+</div>
+
+      <footer>
+      <p>Built by <a href="http://hadley.github.io/pkgdown/">pkgdown</a>. Styled with <a href="http://getbootstrap.com">Bootstrap 3</a>.</p>
+      </footer>
+   </div>
+
+  </body>
+</html>
author	Johannes Ranke <jranke@uni-bremen.de>	2016-10-06 09:19:21 +0200
committer	Johannes Ranke <jranke@uni-bremen.de>	2016-10-06 09:19:21 +0200
commit	38f9e15f0c972c1516ae737a2bca8d7789581bbd (patch)
tree	724c9dc19901f24f427757ac81001f07bf298024 /docs/reference/plot.mmkin.html
parent	ec1487f0f2cef32d44b0c6ce94a6f1b4f65a79d3 (diff)