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

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

Author: dmbates
Date: 2011-11-16 23:43:34 +0100 (Wed, 16 Nov 2011)
New Revision: 1450

Added:
   pkg/lme4Eigen/man/glmFamily.Rd
   pkg/lme4Eigen/man/lmResp.Rd
Modified:
   pkg/lme4Eigen/man/glmFamily-class.Rd
   pkg/lme4Eigen/man/lmResp-class.Rd
Log:
Document the class generator object and the reference class (for now).


Modified: pkg/lme4Eigen/man/glmFamily-class.Rd
===================================================================
--- pkg/lme4Eigen/man/glmFamily-class.Rd	2011-11-16 22:42:49 UTC (rev 1449)
+++ pkg/lme4Eigen/man/glmFamily-class.Rd	2011-11-16 22:43:34 UTC (rev 1450)
@@ -2,7 +2,6 @@
 \Rdversion{1.1}
 \docType{class}
 \alias{glmFamily-class}
-\alias{glmFamily}
 \title{Class \code{"glmFamily"} - a reference class for \code{\link{family}}}
 \description{
   This class is a wrapper class for \code{\link{family}} objects
@@ -27,10 +26,8 @@
   external pointer.  If the \code{Ptr} field is a null pointer, the
   external pointer is regenerated for the stored \code{family} field.
 }
-
-%% ~Make other sections like Warning with \section{Warning }{....} ~
 \seealso{
-  \code{link{family}}
+  \code{\link{family}}, \code{\link{glmFamily}}
 }
 \examples{
 str(glmFamily$new(family=poisson()))

Added: pkg/lme4Eigen/man/glmFamily.Rd
===================================================================
--- pkg/lme4Eigen/man/glmFamily.Rd	                        (rev 0)
+++ pkg/lme4Eigen/man/glmFamily.Rd	2011-11-16 22:43:34 UTC (rev 1450)
@@ -0,0 +1,20 @@
+\name{glmFamily}
+\alias{glmFamily}
+\title{Generator object for the \code{\linkS4class{glmFamily}} class}
+\section{Methods}{
+  \describe{
+    \item{\code{new(family=family)}:}{Create a new
+      \code{\linkS4class{glmFamily}} object}
+  }
+}
+\arguments{
+  \item{family}{a \code{\link{family}} object}
+}
+\note{Arguments to the \code{new} method must be named arguments.}
+\description{The generator object for the \code{\linkS4class{glmFamily}}
+  reference class. Such an object is primarily used through its
+  \code{new} method.}
+\seealso{
+  \code{\linkS4class{glmFamily}}
+}
+\keyword{classes}

Modified: pkg/lme4Eigen/man/lmResp-class.Rd
===================================================================
--- pkg/lme4Eigen/man/lmResp-class.Rd	2011-11-16 22:42:49 UTC (rev 1449)
+++ pkg/lme4Eigen/man/lmResp-class.Rd	2011-11-16 22:43:34 UTC (rev 1450)
@@ -3,14 +3,7 @@
 \alias{glmResp-class}
 \alias{lmerResp-class}
 \alias{nlsResp-class}
-\alias{lmResp}
-\alias{glmResp}
-\alias{nlsResp}
-\alias{lmerResp}
 \title{Classes \code{"lmResp"}, \code{"glmResp"}, \code{"nlsResp"} and \code{"lmerResp"}}
-\usage{
-  lmResp$new(y=y)
-}
 \description{
   Reference classes for response modules, including linear models,
   \code{"lmResp"}, generalized linear models, \code{"glmResp"},

Added: pkg/lme4Eigen/man/lmResp.Rd
===================================================================
--- pkg/lme4Eigen/man/lmResp.Rd	                        (rev 0)
+++ pkg/lme4Eigen/man/lmResp.Rd	2011-11-16 22:43:34 UTC (rev 1450)
@@ -0,0 +1,37 @@
+\name{lmResp}
+\alias{lmResp}
+\alias{lmerResp}
+\alias{glmResp}
+\alias{nlsResp}
+\title{Generator objects for the response classes}
+\section{Methods}{
+  \describe{
+    \item{\code{new(y=y)}:}{Create a new
+      \code{\linkS4class{lmResp}} or \code{\linkS4class{lmerResp}} object}
+    \item{\code{new(family=family, y=y)}:}{Create a new
+      \code{\linkS4class{glmResp}} object}
+    \item{\code{new(y=y, nlmod=nlmod, nlenv=nlenv, pnames=pnames, N=N)}:}{Create a new
+      \code{\linkS4class{nlsResp}} object}
+  }
+}
+\arguments{
+  \item{y}{the numeric response vector}
+  \item{family}{a \code{\link{family}} object}
+  \item{nlmod}{the nonlinear model function}
+  \item{nlenv}{an environment holding data objects for evaluation of
+    \code{nlmod}}
+  \item{pnames}{a character vector of parameter names}
+  \item{N}{an integer scalar - the length of the linear predictor}
+}
+\note{Arguments to the \code{new} methods must be named arguments.}
+\description{The generator objects for the \code{\linkS4class{lmResp}},
+  \code{\linkS4class{lmerResp}}, \code{\linkS4class{glmResp}} and
+  \code{\linkS4class{nlsResp}} reference classes. Such objects are
+  primarily used through their \code{new} methods.}
+\seealso{
+  \code{\linkS4class{lmResp}},
+  \code{\linkS4class{lmerResp}},
+  \code{\linkS4class{glmResp}},
+  \code{\linkS4class{nlsResp}}
+}
+\keyword{classes}