-
-
Notifications
You must be signed in to change notification settings - Fork 24
/
Copy pathextract_variable_array.html
207 lines (174 loc) · 12.7 KB
/
extract_variable_array.html
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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><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>Extract array of a single (possibly indexed) variable — extract_variable_array • posterior</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><link href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.4.0/cosmo/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous"><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css"><script src="../bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"><script src="../pkgdown.js"></script><meta property="og:title" content="Extract array of a single (possibly indexed) variable — extract_variable_array"><meta property="og:description" content="Extract an array of draws of a single variable, including any dimensions of
variables with indices."><meta property="og:image" content="https://mc-stan.org/posterior/logo.svg"><!-- 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><!--[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 data-spy="scroll" data-target="#toc">
<div class="container template-reference-topic">
<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" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span class="navbar-brand">
<a class="navbar-link" href="../index.html">posterior</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">1.6.0</span>
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav"><li>
<a href="../index.html">
<span class="fa fa-home fa-lg"></span>
</a>
</li>
<li>
<a href="../articles/index.html">Vignettes</a>
</li>
<li>
<a href="../reference/index.html">Functions</a>
</li>
<li>
<a href="../news/index.html">News</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false">
Other Packages
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu"><li>
<a href="https://mc-stan.org/rstan" class="external-link">rstan</a>
</li>
<li>
<a href="https://mc-stan.org/cmdstanr" class="external-link">cmdstanr</a>
</li>
<li>
<a href="https://mc-stan.org/rstanarm" class="external-link">rstanarm</a>
</li>
<li>
<a href="https://mc-stan.org/bayesplot" class="external-link">bayesplot</a>
</li>
<li>
<a href="https://mc-stan.org/shinystan" class="external-link">shinystan</a>
</li>
<li>
<a href="https://mc-stan.org/loo" class="external-link">loo</a>
</li>
<li>
<a href="https://mc-stan.org/projpred" class="external-link">projpred</a>
</li>
<li>
<a href="https://mc-stan.org/rstantools" class="external-link">rstantools</a>
</li>
</ul></li>
<li>
<a href="https://mc-stan.org" class="external-link">Stan</a>
</li>
</ul><ul class="nav navbar-nav navbar-right"><li>
<a href="https://twitter.com/mcmc_stan" class="external-link">
<span class="fa fa-twitter"></span>
</a>
</li>
<li>
<a href="https://github.com/stan-dev/posterior" class="external-link">
<span class="fa fa-github"></span>
</a>
</li>
<li>
<a href="https://discourse.mc-stan.org/" class="external-link">
<span class="fa fa-users"></span>
</a>
</li>
</ul></div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
</header><div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>Extract array of a single (possibly indexed) variable</h1>
<small class="dont-index">Source: <a href="https://github.com/stan-dev/posterior/blob/HEAD/R/extract_variable_array.R" class="external-link"><code>R/extract_variable_array.R</code></a></small>
<div class="hidden name"><code>extract_variable_array.Rd</code></div>
</div>
<div class="ref-description">
<p>Extract an array of draws of a single variable, including any dimensions of
variables with indices.</p>
</div>
<div id="ref-usage">
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">extract_variable_array</span><span class="op">(</span><span class="va">x</span>, <span class="va">variable</span>, <span class="va">...</span><span class="op">)</span></span>
<span></span>
<span><span class="co"># S3 method for default</span></span>
<span><span class="fu">extract_variable_array</span><span class="op">(</span><span class="va">x</span>, <span class="va">variable</span>, <span class="va">...</span><span class="op">)</span></span>
<span></span>
<span><span class="co"># S3 method for draws</span></span>
<span><span class="fu">extract_variable_array</span><span class="op">(</span><span class="va">x</span>, <span class="va">variable</span>, <span class="va">...</span><span class="op">)</span></span></code></pre></div>
</div>
<div id="arguments">
<h2>Arguments</h2>
<dl><dt>x</dt>
<dd><p>(draws) A <code>draws</code> object or another <span style="R">R</span> object for which the method
is defined.</p></dd>
<dt>variable</dt>
<dd><p>(string) The name of the variable to extract. To extract all
dimensions from variables with indices (e.g. <code>"x[1]"</code>), provide the base
variable name (e.g. <code>"x"</code>).</p></dd>
<dt>...</dt>
<dd><p>Arguments passed to individual methods (if applicable).</p></dd>
</dl></div>
<div id="value">
<h2>Value</h2>
<p>An <code>array</code> with dimension <code>niterations(x)</code> x <code>nchains(x)</code> x any remaining
dimensions determined by the indices of the variable <code>x</code>.</p>
</div>
<div id="see-also">
<h2>See also</h2>
<div class="dont-index"><p>Other variable extraction methods:
<code><a href="extract_variable.html">extract_variable</a>()</code>,
<code><a href="extract_variable_matrix.html">extract_variable_matrix</a>()</code></p></div>
</div>
<div id="ref-examples">
<h2>Examples</h2>
<div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="va">x</span> <span class="op"><-</span> <span class="fu"><a href="example_draws.html">example_draws</a></span><span class="op">(</span>example <span class="op">=</span> <span class="st">"multi_normal"</span><span class="op">)</span></span></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="va">mu</span> <span class="op"><-</span> <span class="fu">extract_variable_array</span><span class="op">(</span><span class="va">x</span>, variable <span class="op">=</span> <span class="st">"mu"</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/utils/str.html" class="external-link">str</a></span><span class="op">(</span><span class="va">mu</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#></span> num [1:100, 1:4, 1:3] 0.18119 -0.03419 -0.05875 -0.1536 0.00989 ...</span>
<span class="r-out co"><span class="r-pr">#></span> - attr(*, "dimnames")=List of 3</span>
<span class="r-out co"><span class="r-pr">#></span> ..$ : NULL</span>
<span class="r-out co"><span class="r-pr">#></span> ..$ : NULL</span>
<span class="r-out co"><span class="r-pr">#></span> ..$ : NULL</span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="va">mu1</span> <span class="op"><-</span> <span class="fu">extract_variable_array</span><span class="op">(</span><span class="va">x</span>, variable <span class="op">=</span> <span class="st">"mu[1]"</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/utils/str.html" class="external-link">str</a></span><span class="op">(</span><span class="va">mu1</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#></span> num [1:100, 1:4, 1] 0.18119 -0.03419 -0.05875 -0.1536 0.00989 ...</span>
<span class="r-out co"><span class="r-pr">#></span> - attr(*, "dimnames")=List of 3</span>
<span class="r-out co"><span class="r-pr">#></span> ..$ : NULL</span>
<span class="r-out co"><span class="r-pr">#></span> ..$ : NULL</span>
<span class="r-out co"><span class="r-pr">#></span> ..$ : NULL</span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="va">Sigma</span> <span class="op"><-</span> <span class="fu">extract_variable_array</span><span class="op">(</span><span class="va">x</span>, variable <span class="op">=</span> <span class="st">"Sigma"</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/utils/str.html" class="external-link">str</a></span><span class="op">(</span><span class="va">Sigma</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#></span> num [1:100, 1:4, 1:3, 1:3] 1.2 1.14 1.12 1.14 1.19 ...</span>
<span class="r-out co"><span class="r-pr">#></span> - attr(*, "dimnames")=List of 4</span>
<span class="r-out co"><span class="r-pr">#></span> ..$ : NULL</span>
<span class="r-out co"><span class="r-pr">#></span> ..$ : NULL</span>
<span class="r-out co"><span class="r-pr">#></span> ..$ : NULL</span>
<span class="r-out co"><span class="r-pr">#></span> ..$ : NULL</span>
<span class="r-in"><span></span></span>
</code></pre></div>
</div>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
<nav id="toc" data-toggle="toc" class="sticky-top"><h2 data-toc-skip>Contents</h2>
</nav></div>
</div>
<footer><div class="copyright">
<p></p><p>Developed by Paul-Christian Bürkner, Jonah Gabry, Matthew Kay, Aki Vehtari.</p>
</div>
<div class="pkgdown">
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p>
</div>
</footer></div>
</body></html>