File: mkMerMod.Rd

package info (click to toggle)
lme4 2.0-1-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 6,860 kB
  • sloc: cpp: 2,543; makefile: 2
file content (30 lines) | stat: -rw-r--r-- 1,105 bytes parent folder | download | duplicates (2)
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
\name{mkMerMod}
\title{Create a 'merMod' Object}
\alias{mkMerMod}
\description{
  Create an object of (a subclass of) class \code{\linkS4class{merMod}}
  from the environment of the objective function and the value returned
  by the optimizer.
}
\usage{
  mkMerMod(rho, opt, reTrms, fr, mc, lme4conv = NULL)
}
\arguments{
  \item{rho}{the environment of the objective function}
  \item{opt}{the optimization result returned by the optimizer
    (a \code{\link{list}}: see \code{\link{lmerControl}} for required elements)}
  \item{reTrms}{random effects structure from the calling function
       (see \code{\link[reformulas]{mkReTrms}} for required elements)}
  \item{fr}{model frame (see \code{\link{model.frame}})}
  \item{mc}{matched call from the calling function}
  \item{lme4conv}{lme4-specific convergence information
    (results of \code{checkConv})}
}
\value{
  an object from a class that inherits from \code{\linkS4class{merMod}}.
}
%% FIXME: TODO
%% \examples{
%% ## 1) An "empty"   merMod object :
%% ## 2) A  "lmer()-like" merMod object, using our "modular" approach instead of lmer()
%% }