man/varcomp.Rd

   1 \name{varcomp}
   2 \alias{varcomp}
   3 \title{Compute Variance Component Estimates}
   4 \description{
   5   Get variance component estimates from a fitted \code{lme} object.
   6 }
   7 \usage{
   8 varcomp(x, scale = FALSE, cum = FALSE)
   9 }
  10 \arguments{
  11   \item{x}{A fitted \code{lme} object}
  12   \item{scale}{Scale all variance so that they sum to 1}
  13   \item{cum}{Send cumulative variance components.}
  14 }
  15 \details{
  16   Variance computations is done as in Venables and Ripley (2002).
  17 }
  18 \value{
  19   A named vector of class \code{varcomp} with estimated variance components.
  20 }
  21 \references{
  22   Venables, W. N. and Ripley, B. D. (2002) \emph{Modern Applied Statistics
  23   with S (Fourth Edition)}. New York: Springer-Verlag.
  24 }
  25 \author{Julien Dutheil \email{julien.dutheil@univ-montp2.fr}}
  26 \seealso{\code{\link[nlme]{lme}}}
  27 \examples{
  28 data(carnivora)
  29 library(nlme)
  30 m <- lme(log10(SW) ~ 1, random = ~ 1|Order/SuperFamily/Family/Genus, data=carnivora)
  31 v <- varcomp(m, TRUE, TRUE)
  32 plot(v)
  33 }
  34 \keyword{regression}
  35 \keyword{dplot}