-
Notifications
You must be signed in to change notification settings - Fork 1
/
VarCorr.html
95 lines (64 loc) · 2.52 KB
/
VarCorr.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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><title>R: Extract variance and correlation components</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="R.css">
</head><body>
<table width="100%" summary="page for VarCorr"><tr><td>VarCorr</td><td align="right">R Documentation</td></tr></table>
<h2>Extract variance and correlation components</h2>
<h3>Description</h3>
<p>This function calculates the estimated variances, standard
deviations, and correlations between the random-effects terms in a
linear mixed-effects model, of class <code>lme</code>, or a nonlinear
mixed-effects model, of class <code>nlme</code>. The within-group error
variance and standard deviation are also calculated.
</p>
<h3>Usage</h3>
<pre>
VarCorr(x, sigma, rdig)
</pre>
<h3>Arguments</h3>
<table summary="R argblock">
<tr valign="top"><td><code>x</code></td>
<td>
<p>a fitted model object, usually an object inheriting from
class <code>lme</code>.
</p>
</td></tr>
<tr valign="top"><td><code>sigma</code></td>
<td>
<p>an optional numeric value used as a multiplier for the
standard deviations. Default is <code>1</code>.
</p>
</td></tr>
<tr valign="top"><td><code>rdig</code></td>
<td>
<p>an optional integer value specifying the number of digits
used to represent correlation estimates. Default is <code>3</code>.
</p>
</td></tr>
</table>
<h3>Value</h3>
<p>a matrix with the estimated variances, standard deviations, and
correlations for the random effects. The first two columns, named
<code>Variance</code> and <code>StdDev</code>, give, respectively, the variance
and the standard deviations. If there are correlation components in
the random effects model, the third column, named <code>Corr</code>,
and the remaining unnamed columns give the estimated correlations
among random effects within the same level of grouping. The
within-group error variance and standard deviation are included as
the last row in the matrix.
</p>
<h3>Author(s)</h3>
<p>Jose Pinheiro and Douglas Bates <a href="mailto:bates@stat.wisc.edu">bates@stat.wisc.edu</a></p>
<h3>References</h3>
<p>Pinheiro, J.C., and Bates, D.M. (2000) "Mixed-Effects Models
in S and S-PLUS", Springer, esp. pp. 100, 461.
</p>
<h3>See Also</h3>
<p><code>lme</code>, <code>nlme</code></p>
<h3>Examples</h3>
<pre>
fm1 <- lme(distance ~ age, data = Orthodont, random = ~age)
VarCorr(fm1)
</pre>
</body></html>