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
|
% File nlme/man/coef.modelStruct.Rd
% Part of the nlme package for R
% Distributed under GPL 2 or later: see nlme/LICENCE.note
\name{coef.modelStruct}
\title{Extract modelStruct Object Coefficients}
\usage{
\method{coef}{modelStruct}(object, unconstrained, \dots)
\method{coef}{modelStruct}(object, \dots) <- value
}
\alias{coef.modelStruct}
\alias{coef<-.modelStruct}
\arguments{
\item{object}{an object inheriting from class \code{"modelStruct"},
representing a list of model components, such as \code{"\link{corStruct}"} and
\code{"\link{varFunc}"} objects.}
\item{unconstrained}{a logical value. If \code{TRUE} the coefficients
are returned in unconstrained form (the same used in the optimization
algorithm). If \code{FALSE} the coefficients are returned in
"natural", possibly constrained, form. Defaults to \code{TRUE}.}
\item{value}{a vector with the replacement values for the coefficients
associated with \code{object}. It must be a vector with the same length
of \code{coef{object}} and must be given in unconstrained form.}
\item{\dots}{some methods for this generic require additional
arguments. None are used in this method.}
}
\description{
This method function extracts the coefficients associated with each
component of the \code{modelStruct} list.
}
\value{
a vector with all coefficients corresponding to the components of
\code{object}.
}
\author{José Pinheiro and Douglas Bates \email{bates@stat.wisc.edu}}
\section{SIDE EFFECTS}{
On the left side of an assignment, sets the values of the coefficients
of \code{object} to \code{value}. \code{Object} must be initialized (using
\code{Initialize}) before new values can be assigned to its
coefficients.
}
\seealso{\code{\link{Initialize}}}
\examples{
lms1 <- lmeStruct(reStruct = reStruct(pdDiag(diag(2), ~age)),
corStruct = corAR1(0.3))
coef(lms1)
}
\keyword{models}
|
