-
Notifications
You must be signed in to change notification settings - Fork 1
/
PCMOptions.html
352 lines (300 loc) · 15.4 KB
/
PCMOptions.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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
<!-- 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>Global options for the PCMBase package — PCMOptions • PCMBase</title>
<!-- jquery -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
<!-- Bootstrap -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha256-916EbMg70RQy9LHiGkXzG8hSg9EdNy97GazNG/aiY1w=" crossorigin="anonymous" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script>
<!-- Font Awesome icons -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.7.1/css/all.min.css" integrity="sha256-nAmazAk6vS34Xqo0BSrTb+abbtFlgsFK7NKSi6o7Y78=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.7.1/css/v4-shims.min.css" integrity="sha256-6qHlizsOWFskGlwVOKuns+D1nB6ssZrHQrNj1wGplHc=" crossorigin="anonymous" />
<!-- clipboard.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.4/clipboard.min.js" integrity="sha256-FiZwavyI2V6+EXO1U+xzLG3IKldpiTFf3153ea9zikQ=" crossorigin="anonymous"></script>
<!-- headroom.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.9.4/headroom.min.js" integrity="sha256-DJFC1kqIhelURkuza0AvYal5RxMtpzLjFhsnVIeuk+U=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.9.4/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="Global options for the PCMBase package — PCMOptions" />
<meta property="og:description" content="Global options for the PCMBase package" />
<meta name="twitter:card" content="summary" />
<!-- 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]-->
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-129563006-3"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-129563006-3');
</script>
</head>
<body>
<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">PCMBase</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">1.2.12</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/PCMBase.html">Get started</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
Articles
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="../articles/PCMParam.html">The PCMBase Parametrization API</a>
</li>
<li>
<a href="../articles/PCMTracePruning.html">Tracing the likelihood calculation of a Gaussian model</a>
</li>
<li>
<a href="../articles/PCMCreateModel.html">Creating a Custom Model in the PCMBase Framework</a>
</li>
</ul>
</li>
<li>
<a href="../reference/index.html">Reference</a>
</li>
<li>
<a href="../news/index.html">News</a>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
</ul>
</div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
</header>
<div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>Global options for the PCMBase package</h1>
<div class="hidden name"><code>PCMOptions.Rd</code></div>
</div>
<div class="ref-description">
<p>Global options for the PCMBase package</p>
</div>
<pre class="usage"><span class='fu'>PCMOptions</span>()</pre>
<h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
<p>a named list with the currently set values of the following global
options:</p><ul>
<li><p><code>PCMBase.Value.NA </code>NA value for the likelihood; used in GaussianPCM to
return this value in case of an error occurring
during likelihood calculation. By default, this is set to <code><a href='https://rdrr.io/r/base/double.html'>as.double(NA)</a></code>.</p></li>
<li><p><code>PCMBase.Errors.As.Warnings </code>a logical flag indicating if errors
(occuring, e.g. during likelihood calculation) should be treated as warnings
and added as an attribute "error" to attach to the likelihood values. Default TRUE.</p></li>
<li><p>PCMBase.Raise.Lik.Errors Should numerical and other sort of
errors occurring during likelihood calculation be raised either as errors or
as warnings, depending on the option <code>PCMBase.Errors.As.Warnings</code>.
Default TRUE. This option can be useful if too frequent warnings get raised
during a model fit procedure.</p></li>
<li><p><code>PCMBase.Threshold.Lambda_ij </code>a 0-threshold for abs(Lambda_i + Lambda_j),
where Lambda_i and Lambda_j are eigenvalues of the parameter matrix H of an OU or
other model. Default 1e-8. See <code><a href='PCMPExpxMeanExp.html'>PCMPExpxMeanExp</a></code>.</p></li>
<li><p><code>PCMBase.Threshold.EV </code>A 0-threshold for the eigenvalues of the
matrix V for a given branch. The V matrix is considered singular if it has
eigenvalues smaller than <code>PCMBase.Threshold.EV </code> or when the ratio
min(svdV)/max(svdV) is below <code>PCMBase.Threshold.SV </code>. Default is 1e-5.
Treatment of branches with singular V matrix is defined by the option
<code>PCMBase.Skip.Singular</code>.</p></li>
<li><p><code>PCMBase.Threshold.SV </code>A 0-threshold for min(svdV)/max(svdV), where
svdV is the vector of singular values of the matrix V for a given branch.
The V matrix is considered singular if it has eigenvalues smaller than
<code>PCMBase.Threshold.EV </code> or when the ratio min(svdV)/max(svdV) is below
PCMBase.Threshold.SV. Default is 1e-6. Treatment
of branches with singular V matrix is defined by the option <code>PCMBase.Skip.Singular</code>.</p></li>
<li><p><code>PCMBase.Threshold.Skip.Singular </code>A double indicating if an internal branch of shorter
length with singular matrix V should be skipped during likelihood calculation. Setting this
option to a higher value, together with a TRUE value for the option PCMBase.Skip.Singular
will result in tolerating some parameter values resulting in singular variance covariance
matrix of the transition distribution. Default 1e-4.</p></li>
<li><p><code>PCMBase.Skip.Singular </code>A logical value indicating whether internal branches with
singular matrix V and shorter than <code><a href='https://rdrr.io/r/base/options.html'>getOption("PCMBase.Threshold.Skip.Singular")</a></code>
should be skipped during likelihood calculation, adding their children
L,m,r values to their parent node. Default TRUE. Note, that setting this option to FALSE
may cause some models to stop working, e.g. the White model. Setting this option to FALSE
will also cause errors or NA likelihood values in the case of trees with very short or
0-length branches.</p></li>
<li><p><code>PCMBase.Tolerance.Symmetric </code>A double specifying the tolerance in tests
for symmetric matrices. Default 1e-8; see also <code><a href='https://rdrr.io/r/base/isSymmetric.html'>isSymmetric</a></code>.</p></li>
<li><p><code>PCMBase.Lmr.mode</code> An integer code specifying the parallel likelihood calculation mode.</p></li>
<li><p><code>PCMBase.ParamValue.LowerLimit</code> Default lower limit value for parameters, default setting is -10.0.</p></li>
<li><p><code>PCMBase.ParamValue.LowerLimit.NonNegativeDiagonal</code> Default lower limit value for parameters corresponding to non-negative diagonal elements of matrices, default setting is 0.0.</p></li>
<li><p><code>PCMBase.ParamValue.UpperLimit</code> Default upper limit value for parameters, default setting is 10.0.</p></li>
<li><p><code>PCMBase.Transpose.Sigma_x</code> Should upper diagonal factors for variance-covariance rate matrices be transposed, e.g. should Sigma = t(Sigma_x) Sigma_x or, rather Sigma = Sigma_x t(Sigma_x)? Note that the two variants are not equal. The default is FALSE, meaning Sigma = Sigma_x t(Sigma_x). In this case, Sigma_x is not the actual upper Cholesky factor of Sigma, i.e. chol(Sigma) != Sigma_x. See also <code><a href='https://rdrr.io/r/base/chol.html'>chol</a></code> and <code><a href='UpperTriFactor.html'>UpperTriFactor</a></code>. This option applies to parameters Sigma_x, Sigmae_x, Sigmaj_x and the measurement errors <code>SE[,,i]</code> for each measurement i when the argument <code>SE</code> is specified as a cube.</p></li>
<li><p><code>PCMBase.MaxLengthListCladePartitions</code> Maximum number of tree partitions returned by <code><a href='PCMTreeListCladePartitions.html'>PCMTreeListCladePartitions</a></code>. This option has the goal to interrupt the recursive search for new partitions in the case of calling PCMTreeListCladePartitions on a big tree with a small value of the maxCladeSize argument. By default this is set to Inf.</p></li>
<li><p><code>PCMBase.PCMPresentCoordinatesFun</code> A function with the same synopsis as <code><a href='PCMPresentCoordinates.html'>PCMPresentCoordinates</a></code> that can be specified in case of custom setting for the present coordinates for specific nodes of the tree. See <code><a href='PCMPresentCoordinates.html'>PCMPresentCoordinates</a></code>, and <code><a href='PCMInfo.html'>PCMInfo</a></code>.</p></li>
<li><p><code>PCMBase.Use1DClasses</code> Logical indicating if 1D arithmetic operations
should be used instead of multi-dimensional ones. This can speed-up computations
in the case of a single trait. Currently, this feature is implemented only in
the PCMBaseCpp R-package and only for some model types, such as OU and BM.
Default: FALSE</p></li>
<li><p><code>PCMBase.PrintSubscript_u</code> Logical indicating if a subscript 'u'
should be printed instead of a subscript 'x'. Used in <code>PCMTable</code>. Default: FALSE.</p></li>
<li><p><code>PCMBase.MaxNForGuessSigma_x</code> A real fraction number in the
interval (0, 1) or an integer bigger than 1 controlling the
number of tips to use for analytical calculation of the evolutionary rate
matrix under a BM assumption. This option is used in the suggested PCMFit
R-package. Default: 0.25.</p></li>
<li><p><code>PCMBase.UsePCMVarForVCV</code> Logical (default: FALSE) indicating
if the function <code><a href='PCMTreeVCV.html'>PCMTreeVCV</a></code> should use <code><a href='PCMVar.html'>PCMVar</a></code>
instead of ape's function <code>vcv</code> to calculate the phylogenetic
variance covariance matrix under BM assumption. Note that setting this option
to TRUE would slow down the function PCMTreeVCV considerably but may be more
stable, particularly in the case of very big and deep trees, where previous
ape's versions of the <code>vcv</code> function have thrown stack-overflow
errors.</p></li>
</ul>
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
<pre class="examples"><div class='input'><span class='fu'>PCMOptions</span>()</div><div class='output co'>#> $PCMBase.Value.NA
#> [1] NA
#>
#> $PCMBase.Errors.As.Warnings
#> [1] TRUE
#>
#> $PCMBase.Threshold.Lambda_ij
#> [1] 1e-08
#>
#> $PCMBase.Threshold.EV
#> [1] 1e-05
#>
#> $PCMBase.Threshold.SV
#> [1] 1e-06
#>
#> $PCMBase.Threshold.Skip.Singular
#> [1] 1e-04
#>
#> $PCMBase.Skip.Singular
#> [1] TRUE
#>
#> $PCMBase.Tolerance.Symmetric
#> [1] 1e-08
#>
#> $PCMBase.Lmr.mode
#> [1] 11
#>
#> $PCMBase.ParamValue.LowerLimit.NonNegativeDiagonal
#> [1] 0
#>
#> $PCMBase.ParamValue.LowerLimit
#> [1] -10
#>
#> $PCMBase.ParamValue.UpperLimit
#> [1] 10
#>
#> $PCMBase.Transpose.Sigma_x
#> [1] FALSE
#>
#> $PCMBase.MaxLengthListCladePartitions
#> [1] Inf
#>
#> $PCMBase.PCMPresentCoordinatesFun
#> function (X, tree, metaI)
#> {
#> if (is.null(metaI)) {
#> N <- PCMTreeNumTips(tree)
#> M <- PCMTreeNumNodes(tree)
#> k <- nrow(X)
#> postorder <- PCMTreePostorder(tree)
#> }
#> else {
#> N <- metaI$N
#> M <- metaI$M
#> k <- metaI$k
#> postorder <- rev(metaI$preorder)
#> }
#> edge <- tree$edge
#> if (is.null(X)) {
#> pc <- matrix(TRUE, k, M)
#> }
#> else {
#> pc <- matrix(FALSE, k, M)
#> for (ei in postorder) {
#> i <- edge[ei, 2]
#> j <- edge[ei, 1]
#> if (i <= N) {
#> pc[, i] <- !is.nan(X[, i])
#> }
#> else {
#> }
#> pc[, j] <- pc[, j] | pc[, i]
#> }
#> pc[, seq_len(N)] <- !is.na(X[, seq_len(N)])
#> if (any(rowSums(pc) == 0)) {
#> stop("PCMPresentCoordinates:: Some tips have 0 present coordinates.\n Consider removing these tips.")
#> }
#> }
#> pc
#> }
#> <bytecode: 0x000000002d7310e8>
#> <environment: namespace:PCMBase>
#>
#> $PCMBase.Use1DClasses
#> [1] FALSE
#>
#> $PCMBase.Raise.Lik.Errors
#> [1] TRUE
#>
#> $PCMBase.PrintSuffix_u
#> [1] FALSE
#>
#> $PCMBase.MaxNForGuessSigma_x
#> [1] 0.25
#>
#> $PCMBase.UsePCMVarForVCV
#> [1] FALSE
#> </div></pre>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
<h2>Contents</h2>
<ul class="nav nav-pills nav-stacked">
<li><a href="#value">Value</a></li>
<li><a href="#examples">Examples</a></li>
</ul>
</div>
</div>
<footer>
<div class="copyright">
<p>Developed by Venelin Mitov.</p>
</div>
<div class="pkgdown">
<p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.4.1.</p>
</div>
</footer>
</div>
</body>
</html>