aboutsummaryrefslogtreecommitdiff
path: root/inst/web/plot.mmkin.html
blob: c12f92f21e1246ebe907e0e2f3aeea65d221c7fb (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
<title>plot.mmkin. mkin 0.9.43.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="#">mkin 0.9.43.9000</a>
      <div class="nav">
        <ul class="nav">
          <li><a href="index.html"><i class="icon-home icon-white"></i> Index</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><div>"plot"(x, main&nbsp;=&nbsp;"auto", legends&nbsp;=&nbsp;1, errmin_var&nbsp;=&nbsp;"All data", errmin_digits&nbsp;=&nbsp;3,  cex&nbsp;=&nbsp;0.7, rel.height.middle&nbsp;=&nbsp;0.9, ...)</div></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.inside-r.org/r-doc/graphics/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'>  # Only use one core not to offend CRAN checks, use Levenberg-Marquardt for speed
  fits &lt;- mmkin(c(&quot;FOMC&quot;, &quot;HS&quot;), list(&quot;FOCUS B&quot; = FOCUS_2006_B, &quot;FOCUS C&quot; = FOCUS_2006_C), 
                cores = 1, quiet = TRUE, method.modFit = &quot;Marq&quot;)
  plot(fits[, &quot;FOCUS C&quot;])
</div>
<p><img src='plot.mmkin-2.png' alt='' width='540' height='400' /></p>
<div class='input'>  plot(fits[&quot;FOMC&quot;, ])
</div>
<p><img src='plot.mmkin-4.png' alt='' width='540' height='400' /></p>
<div class='input'>
  # We can also plot a single fit, if we like the way mmkin works, but then the plot 
  # height should be smaller than the plot width (this is not possible for the html pages
  # generated by staticdocs, as far as I know).
  plot(fits[&quot;FOMC&quot;, &quot;FOCUS C&quot;]) # same as plot(fits[1, 2])
</div>
<p><img src='plot.mmkin-6.png' alt='' width='540' height='400' /></p></pre>
  </div>
  <div class="span4">
    <!-- <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="http://twitter.github.com/bootstrap">bootstrap</a>.</p>
      </footer>
    </div>
  </body>
</html>

Contact - Imprint