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

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

Author: dmbates
Date: 2011-11-04 20:21:35 +0100 (Fri, 04 Nov 2011)
New Revision: 1438

Added:
   pkg/lme4Eigen/man/merPredD.Rd
Modified:
   pkg/lme4Eigen/man/merPredD-class.Rd
Log:
Try to document reference class generator object this way


Modified: pkg/lme4Eigen/man/merPredD-class.Rd
===================================================================
--- pkg/lme4Eigen/man/merPredD-class.Rd	2011-11-04 19:20:49 UTC (rev 1437)
+++ pkg/lme4Eigen/man/merPredD-class.Rd	2011-11-04 19:21:35 UTC (rev 1438)
@@ -1,29 +1,12 @@
 \name{merPredD-class}
 \alias{merPredD-class}
-\alias{merPredD}
 \title{Class \code{"merPredD"} -  a dense predictor reference class}
-\usage{
-  merPredD$new(X=X, Zt=Zt, Lambdat=Lambdat, Lind=Lind, theta=theta)
-}
-\arguments{
-  \item{X}{dense model matrix for the fixed-effects parameters, to be
-    stored in the \code{X} field.}
-  \item{Zt}{transpose of the sparse model matrix for the random
-    effects.  It is stored in the \code{Zt} field.}
-  \item{Lambdat}{transpose of the sparse lower triangular relative
-    variance factor (stored in the \code{Lambdat} field).}
-  \item{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{theta}{numeric vector of variance component parameters (stored
-    in the \code{theta} field).}
-}
 \description{
   A reference class for a mixed-effects model predictor module with a
   dense model matrix for the fixed-effects parameters.  The reference
   class is associated with a C++ class of the same name.  As is
-  customary, the generator object for the class has the same name as the
-  class.
+  customary, the generator object, \code{\link{merPredD}}, for the class
+  has the same name as the class.
 }
 \section{Extends}{
   All reference classes extend and inherit methods from
@@ -45,7 +28,8 @@
   % function, not directly as the R object field.
 }
 \seealso{
-  \code{\link{lmer}}, \code{\link{glmer}}, \code{\link{nlmer}}, \code{\linkS4class{merMod}}.
+  \code{\link{lmer}}, \code{\link{glmer}}, \code{\link{nlmer}},
+  \code{\link{merPredD}}, \code{\linkS4class{merMod}}.
 }
 \examples{
 showClass("merPredD")

Added: pkg/lme4Eigen/man/merPredD.Rd
===================================================================
--- pkg/lme4Eigen/man/merPredD.Rd	                        (rev 0)
+++ pkg/lme4Eigen/man/merPredD.Rd	2011-11-04 19:21:35 UTC (rev 1438)
@@ -0,0 +1,26 @@
+\name{merPredD}
+\alias{merPredD}
+\title{Generator object for the \code{\linkS4class{merPredD}} class}
+\section{Methods}{
+  \describe{
+    \item{\code{new(X, Zt, Lambdat, Lind, theta)}:}{Create a new
+      \code{\linkS4class{merPredD}} object}
+  }
+}
+\arguments{
+  \item{X}{dense model matrix for the fixed-effects parameters, to be
+    stored in the \code{X} field.}
+  \item{Zt}{transpose of the sparse model matrix for the random
+    effects.  It is stored in the \code{Zt} field.}
+  \item{Lambdat}{transpose of the sparse lower triangular relative
+    variance factor (stored in the \code{Lambdat} field).}
+  \item{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{theta}{numeric vector of variance component parameters (stored
+    in the \code{theta} field).}
+}
+\seealso{
+  \code{\linkS4class{merPredD}}
+}
+\keyword{classes}