File: merPredD.Rd

package info (click to toggle)
lme4 2.0-1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,860 kB
  • sloc: cpp: 2,543; makefile: 2
file content (39 lines) | stat: -rw-r--r-- 1,451 bytes parent folder | download | duplicates (6)
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
31
32
33
34
35
36
37
38
39
\name{merPredD}
\alias{merPredD}
\title{Generator object for the \code{\linkS4class{merPredD}} class}
\usage{
merPredD(...)
}
\arguments{
  \item{...}{List of arguments (see Note).}
}
\description{
  The generator object for the
  \code{\linkS4class{merPredD}} reference class. Such an
  object is primarily used through its \code{new} method.
}
\note{
  \code{merPredD(...)} is a short form of \code{new("merPredD", ...)}
  to create a new \code{\linkS4class{merPredD}} object and the
  \code{...} must be named arguments, \code{(X, Zt, Lambdat, Lind,
    theta,n)}:
  \describe{
    \item{\code{X}:}{dense model matrix for the fixed-effects parameters, to be
      stored in the \code{X} field.}
    \item{\code{Zt}:}{transpose of the sparse model matrix for the random
      effects.  It is stored in the \code{Zt} field.}
    \item{\code{Lambdat}:}{transpose of the sparse lower triangular relative
      variance factor (stored in the \code{Lambdat} field).}
    \item{\code{Lind}:}{integer vector of the same length as the \code{x} slot in the
      \code{Lambdat} field.  Its elements should be in the range 1 to
      the length of the \code{theta} field.}
    \item{\code{theta}:}{numeric vector of variance component parameters (stored
      in the \code{theta} field).}
    \item{\code{n}:}{sample size, usually \code{nrow(X)}.}
  }
}
\seealso{
  The class definition, \code{\linkS4class{merPredD}}, also for examples.
}
\keyword{classes}