fitted.lmeStruct            package:nlme            R Documentation

Calculate lmeStruct Fitted Values

Description:

     The fitted values at level 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 i. The
     resulting values estimate the best linear unbiased predictions
     (BLUPs) at level i.

Usage:

     ## S3 method for class 'lmeStruct':
     fitted(object, level, conLin, lmeFit, ...)

Arguments:

  object: an object inheriting from class 'lmeStruct', representing a
          list of linear mixed-effects model components, such as
          'reStruct', 'corStruct', and 'varFunc' objects.

   level: an optional integer vector giving the level(s) of grouping to
          be used in extracting the fitted values from '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.

  conLin: an optional condensed linear model object, consisting of a
          list with components '"Xy"', corresponding to a regression
          matrix ('X') combined with a response vector ('y'), and 
          '"logLik"', corresponding to the log-likelihood of the
          underlying lme model. Defaults to 'attr(object, "conLin")'.

  lmeFit: an optional list with components 'beta' and 'b' containing
          respectively the fixed effects estimates and the random
          effects estimates to be used to calculate the fitted values.
          Defaults to 'attr(object, "lmeFit")'.

     ...: some methods for this generic accept other optional
          arguments.

Value:

     if a single level of grouping is specified in 'level', the
     returned value is a vector with the fitted values at the desired
     level; else, when multiple grouping levels are specified in
     'level', the returned object is a matrix with  columns given by
     the fitted values at different levels.

Note:

     This method function is generally only used inside 'lme' and 
     'fitted.lme'.

Author(s):

     Jose Pinheiro Jose.Pinheiro@pharma.novartis.com and Douglas Bates
     bates@stat.wisc.edu

References:

     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/

See Also:

     'lme', 'fitted.lme', 'residuals.lmeStruct'

