[Lme4-commits] r1404 - pkg/lme4Eigen/man

[noreply at r-forge.r-project.org]

Author: mmaechler
Date: 2011-09-23 10:20:06 +0200 (Fri, 23 Sep 2011)
New Revision: 1404

Added:
   pkg/lme4Eigen/man/refitML.Rd
Log:
add doc. + example

Added: pkg/lme4Eigen/man/refitML.Rd
===================================================================
--- pkg/lme4Eigen/man/refitML.Rd	                        (rev 0)
+++ pkg/lme4Eigen/man/refitML.Rd	2011-09-23 08:20:06 UTC (rev 1404)
@@ -0,0 +1,28 @@
+\name{refitML}
+\title{Refit a Mixed-Effect Model by Maximum Likelihood (ML)}
+\alias{refitML}
+\alias{refitML.merMod}
+\description{
+  Refits a fitted mixed-effecs model by maximum likelihood,
+  typically a \emph{linear} ME model which was fit by REML.
+}
+\usage{
+refitML(x)
+}
+\arguments{
+  \item{x}{an object of class \code{\linkS4class{merMod}}.}
+}
+\value{
+  an \R object, typically of class  \code{\linkS4class{lmerMod}},
+  similar to \code{x}, but refit by ML (if needed).
+}
+\seealso{
+  \code{\link{lmer}()}; class \code{\linkS4class{lmerMod}}.
+}
+\examples{
+(fm1 <- lmer(Reaction ~ Days + (Days|Subject), sleepstudy))
+(fm1M <- refitML(fm1))
+## The random effects, differ, but the fixed effects are the same:
+stopifnot(all.equal(fixef(fm1), fixef(fm1M)))
+}
+\keyword{models}