/
getters.html
256 lines (195 loc) · 14.2 KB
/
getters.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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
<html lang="en">
<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>Extracts components of bicop_dist and vinecop_dist objects — getters • rvinecopulib</title>
<!-- jquery -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>
<!-- Bootstrap -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" 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="Extracts components of bicop_dist and vinecop_dist objects — getters" />
<meta property="og:description" content="Extracts either the structure matrix (for vinecop_dist only), or
pair-copulas, their parameters, Kendall's taus, or families (for bicop_dist
and vinecop_dist)." />
<!-- 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">rvinecopulib</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.6.1.1.0</span>
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
<a href="../index.html">
<span class="fas fa-home fa-lg"></span>
</a>
</li>
<li>
<a href="../reference/index.html">Reference</a>
</li>
<li>
<a href="../news/index.html">Changelog</a>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li>
<a href="https://github.com/vinecopulib/rvinecopulib/">
<span class="fab fa-github fa-lg"></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>Extracts components of <code>bicop_dist</code> and <code>vinecop_dist</code> objects</h1>
<small class="dont-index">Source: <a href='https://github.com/vinecopulib/rvinecopulib/blob/master/R/getters.R'><code>R/getters.R</code></a></small>
<div class="hidden name"><code>getters.Rd</code></div>
</div>
<div class="ref-description">
<p>Extracts either the structure matrix (for <code>vinecop_dist</code> only), or
pair-copulas, their parameters, Kendall's taus, or families (for <code>bicop_dist</code>
and <code>vinecop_dist</code>).</p>
</div>
<pre class="usage"><span class='fu'>get_structure</span><span class='op'>(</span><span class='va'>object</span><span class='op'>)</span>
<span class='fu'>get_pair_copula</span><span class='op'>(</span><span class='va'>object</span>, tree <span class='op'>=</span> <span class='cn'>NA</span>, edge <span class='op'>=</span> <span class='cn'>NA</span><span class='op'>)</span>
<span class='fu'>get_parameters</span><span class='op'>(</span><span class='va'>object</span>, tree <span class='op'>=</span> <span class='cn'>NA</span>, edge <span class='op'>=</span> <span class='cn'>NA</span><span class='op'>)</span>
<span class='fu'>get_ktau</span><span class='op'>(</span><span class='va'>object</span>, tree <span class='op'>=</span> <span class='cn'>NA</span>, edge <span class='op'>=</span> <span class='cn'>NA</span><span class='op'>)</span>
<span class='fu'>get_family</span><span class='op'>(</span><span class='va'>object</span>, tree <span class='op'>=</span> <span class='cn'>NA</span>, edge <span class='op'>=</span> <span class='cn'>NA</span><span class='op'>)</span>
<span class='fu'>get_all_pair_copulas</span><span class='op'>(</span><span class='va'>object</span>, trees <span class='op'>=</span> <span class='cn'>NA</span><span class='op'>)</span>
<span class='fu'>get_all_parameters</span><span class='op'>(</span><span class='va'>object</span>, trees <span class='op'>=</span> <span class='cn'>NA</span><span class='op'>)</span>
<span class='fu'>get_all_ktaus</span><span class='op'>(</span><span class='va'>object</span>, trees <span class='op'>=</span> <span class='cn'>NA</span><span class='op'>)</span>
<span class='fu'>get_all_families</span><span class='op'>(</span><span class='va'>object</span>, trees <span class='op'>=</span> <span class='cn'>NA</span><span class='op'>)</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>object</th>
<td><p>a <code>bicop_dist</code>, <code>vinecop_dist</code> or <code>vine_dist</code> object.</p></td>
</tr>
<tr>
<th>tree</th>
<td><p>tree index (not required if <code>object</code> is of class <code>bicop_dist</code>).</p></td>
</tr>
<tr>
<th>edge</th>
<td><p>edge index (not required if <code>object</code> is of class <code>bicop_dist</code>).</p></td>
</tr>
<tr>
<th>trees</th>
<td><p>the trees to extract from <code>object</code> (<code>trees = NA</code> extracts all
trees).</p></td>
</tr>
</table>
<h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
<p>The structure matrix, or pair-copulas, their parameters, Kendall's taus,
or families.</p>
<h2 class="hasAnchor" id="details"><a class="anchor" href="#details"></a>Details</h2>
<p>#' The get_structure method (for <code>vinecop_dist</code> or <code>vine_dist</code>
objects only) extracts the structure (see <a href='rvine_structure.html'>rvine_structure</a> for more
details).</p>
<p>The get_matrix method (for <code>vinecop_dist</code> or <code>vine_dist</code> objects only)
extracts the structure matrix (see <a href='rvine_structure.html'>rvine_structure</a> for more details).</p>
<p>The other <code>get_xyz</code> methods for <code>vinecop_dist</code> or <code>vine_dist</code> objects return
the entries corresponding to the pair-copula indexed by its <code>tree</code> and
<code>edge</code>. When <code>object</code> is of class <code>bicop_dist</code>, <code>tree</code> and <code>edge</code> are not
required. <br /></p><ul>
<li><p><code>get_pair_copula()</code> = the pair-copula itself (see <a href='bicop.html'>bicop</a>).</p></li>
<li><p><code>get_parameters()</code> = the parameters of the pair-copula (i.e., a <code>numeric</code>
scalar, vector, or matrix).</p></li>
<li><p><code>get_family()</code> = a character for the family (see <a href='bicop.html'>bicop</a> for
implemented families).</p></li>
<li><p><code>get_ktau()</code> = a <code>numeric</code> scalar with the pair-copula Kendall's tau.</p></li>
</ul>
<p>The <code>get_all_xyz</code> methods (for <code>vinecop_dist</code> or <code>vine_dist</code> objects only)
return lists of lists, with each element corresponding to a tree in <code>trees</code>,
and then elements of the sublists correspond to edges. The returned lists
have two additional attributes:</p><ul>
<li><p><code>"d"</code> = the dimension of the model.</p></li>
<li><p><code>"trees"</code> = the extracted trees.</p></li>
</ul>
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
<pre class="examples"><div class='input'><span class='co'># specify pair-copulas</span>
<span class='va'>bicop</span> <span class='op'><-</span> <span class='fu'><a href='bicop_dist.html'>bicop_dist</a></span><span class='op'>(</span><span class='st'>"bb1"</span>, <span class='fl'>90</span>, <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span><span class='op'>(</span><span class='fl'>3</span>, <span class='fl'>2</span><span class='op'>)</span><span class='op'>)</span>
<span class='va'>pcs</span> <span class='op'><-</span> <span class='fu'><a href='https://rdrr.io/r/base/list.html'>list</a></span><span class='op'>(</span>
<span class='fu'><a href='https://rdrr.io/r/base/list.html'>list</a></span><span class='op'>(</span><span class='va'>bicop</span>, <span class='va'>bicop</span><span class='op'>)</span>, <span class='co'># pair-copulas in first tree</span>
<span class='fu'><a href='https://rdrr.io/r/base/list.html'>list</a></span><span class='op'>(</span><span class='va'>bicop</span><span class='op'>)</span> <span class='co'># pair-copulas in second tree</span>
<span class='op'>)</span>
<span class='co'># specify R-vine matrix</span>
<span class='va'>mat</span> <span class='op'><-</span> <span class='fu'><a href='https://rdrr.io/r/base/matrix.html'>matrix</a></span><span class='op'>(</span><span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span><span class='op'>(</span><span class='fl'>1</span>, <span class='fl'>2</span>, <span class='fl'>3</span>, <span class='fl'>1</span>, <span class='fl'>2</span>, <span class='fl'>0</span>, <span class='fl'>1</span>, <span class='fl'>0</span>, <span class='fl'>0</span><span class='op'>)</span>, <span class='fl'>3</span>, <span class='fl'>3</span><span class='op'>)</span>
<span class='co'># set up vine copula model</span>
<span class='va'>vc</span> <span class='op'><-</span> <span class='fu'><a href='vinecop_dist.html'>vinecop_dist</a></span><span class='op'>(</span><span class='va'>pcs</span>, <span class='va'>mat</span><span class='op'>)</span>
<span class='co'># get the structure</span>
<span class='fu'>get_structure</span><span class='op'>(</span><span class='va'>vc</span><span class='op'>)</span>
</div><div class='output co'>#> 3-dimensional R-vine structure ('rvine_structure')
#> 1 1 1
#> 2 2
#> 3 </div><div class='input'><span class='fu'><a href='https://rdrr.io/r/base/all.html'>all</a></span><span class='op'>(</span><span class='fu'>get_matrix</span><span class='op'>(</span><span class='va'>vc</span><span class='op'>)</span> <span class='op'>==</span> <span class='va'>mat</span><span class='op'>)</span>
</div><div class='output co'>#> [1] TRUE</div><div class='input'>
<span class='co'># get pair-copulas</span>
<span class='fu'>get_pair_copula</span><span class='op'>(</span><span class='va'>vc</span>, <span class='fl'>1</span>, <span class='fl'>1</span><span class='op'>)</span>
</div><div class='output co'>#> Bivariate copula ('bicop_dist'): family = bb1, rotation = 90, parameters = 3, 2, var_types = c,c</div><div class='input'><span class='fu'>get_all_pair_copulas</span><span class='op'>(</span><span class='va'>vc</span><span class='op'>)</span>
</div><div class='output co'>#> Nested list of lists for the pair-copulas of a 3 dimensional vine with all trees:
#> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#> x[[1]] -> a list with the 2 pair-copulas of tree 1.
#> x[[2]] -> a list with the 1 pair-copulas of tree 2. </div><div class='input'><span class='fu'><a href='https://rdrr.io/r/base/all.equal.html'>all.equal</a></span><span class='op'>(</span><span class='fu'>get_all_pair_copulas</span><span class='op'>(</span><span class='va'>vc</span><span class='op'>)</span>, <span class='va'>pcs</span>,
check.attributes <span class='op'>=</span> <span class='cn'>FALSE</span>, check.environment <span class='op'>=</span> <span class='cn'>FALSE</span><span class='op'>)</span>
</div><div class='output co'>#> [1] TRUE</div></pre>
</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>Developed by Thomas Nagler, Thibault Vatter.</p>
</div>
<div class="pkgdown">
<p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.6.1.</p>
</div>
</footer>
</div>
</body>
</html>