coef.lme {nlme} | R Documentation |
Extract lme Coefficients
Description
The estimated coefficients at level i
are obtained by adding
together the fixed effects estimates and the corresponding random
effects estimates at grouping levels less or equal to i
. The
resulting estimates are returned as a data frame, with rows
corresponding to groups and columns to coefficients. Optionally, the
returned data frame may be augmented with covariates summarized over
groups.
Usage
## S3 method for class 'lme'
coef(object, augFrame, level, data, which, FUN,
omitGroupingFactor, subset, ...)
Arguments
object |
an object inheriting from class |
augFrame |
an optional logical value. If |
level |
an optional positive integer giving the level of grouping to be used in extracting the coefficients from an object with multiple nested grouping levels. Defaults to the highest or innermost level of grouping. |
data |
an optional data frame with the variables to be used for
augmenting the returned data frame when |
which |
an optional positive integer or character vector
specifying which columns of |
FUN |
an optional summary function or a list of summary functions
to be applied to group-varying variables, when collapsing |
omitGroupingFactor |
an optional logical value. When |
subset |
an optional expression specifying a subset |
... |
some methods for this generic require additional arguments. None are used in this method. |
Value
a data frame inheriting from class "coef.lme"
with the estimated
coefficients at level level
and, optionally, other covariates
summarized over groups. The returned object also inherits from classes
"ranef.lme"
and "data.frame"
.
Author(s)
José Pinheiro and Douglas Bates bates@stat.wisc.edu
References
Pinheiro, J. C. and Bates, D. M. (2000), Mixed-Effects Models in S and S-PLUS, Springer, New York, esp. pp. 455-457.
See Also
lme
,
ranef.lme
,
plot.ranef.lme
, gsummary
Examples
fm1 <- lme(distance ~ age, Orthodont, random = ~ age | Subject)
coef(fm1)
coef(fm1, augFrame = TRUE)