\Header{fitted.lmeStruct}{Calculate lmeStruct Fitted Values}
\keyword{models}{fitted.lmeStruct}
\begin{Description}\relax
The fitted values at level \eqn{i}{} are obtained by adding together the
population fitted values (based only on the fixed effects estimates)
and the estimated contributions of the random effects to the fitted
values at grouping levels less or equal to \eqn{i}{}. The resulting
values estimate the best linear unbiased predictions (BLUPs) at level
\eqn{i}{}.\end{Description}
\begin{Usage}
\begin{verbatim}
## S3 method for class 'lmeStruct':
fitted(object, level, conLin, lmeFit, ...)
\end{verbatim}
\end{Usage}
\begin{Arguments}
\begin{ldescription}
\item[\code{object}] an object inheriting from class \code{lmeStruct},
representing a list of linear mixed-effects model components, such as
\code{reStruct}, \code{corStruct}, and \code{varFunc} objects.
\item[\code{level}] an optional integer vector giving the level(s) of grouping
to be used in extracting the fitted values from \code{object}. Level
values increase from outermost to innermost grouping, with
level zero corresponding to the population fitted values. Defaults to
the highest or innermost level of grouping.
\item[\code{conLin}] an optional condensed linear model object, consisting of
a list with components \code{"Xy"}, corresponding to a regression
matrix (\code{X}) combined with a response vector (\code{y}), and 
\code{"logLik"}, corresponding to the log-likelihood of the
underlying lme model. Defaults to \code{attr(object, "conLin")}.
\item[\code{lmeFit}] an optional list with components \code{beta} and \code{b}
containing respectively the fixed effects estimates and the random
effects estimates to be used to calculate the fitted values. Defaults
to \code{attr(object, "lmeFit")}.
\item[\code{...}] some methods for this generic accept other optional arguments.
\end{ldescription}
\end{Arguments}
\begin{Value}
if a single level of grouping is specified in \code{level},
the returned value is a vector with the fitted values at the desired
level; else, when multiple grouping levels are specified in
\code{level}, the returned object is a matrix with 
columns given by the fitted values at different levels.\end{Value}
\begin{Note}\relax
This method function is generally only used inside \code{lme} and 
\code{fitted.lme}.\end{Note}
\begin{Author}\relax
Jose Pinheiro \email{Jose.Pinheiro@pharma.novartis.com} and Douglas Bates \email{bates@stat.wisc.edu}\end{Author}
\begin{References}\relax
Bates, D.M. and Pinheiro, J.C. (1998) "Computational methods for
multilevel models" available in PostScript or PDF formats at
http://franz.stat.wisc.edu/pub/NLME/\end{References}
\begin{SeeAlso}\relax
\code{\Link{lme}}, \code{\Link{fitted.lme}},
\code{\Link{residuals.lmeStruct}}\end{SeeAlso}

