Fixed documentation so that R CMD check succeeds

melff · May 11, 2020 · e6d0674 · e6d0674
1 parent b7bacc4
commit e6d0674
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 15 deletions.
diff --git a/pkg/R/mblogit.R b/pkg/R/mblogit.R
@@ -32,7 +32,7 @@
 #' of \code{model.matrix.default}.
 #' @param control a list of parameters for the fitting process.
 #' See \code{\link{mclogit.control}}
-#' @param \dots arguments to be passed to \code{mclogit.control}
+#' @param \dots arguments to be passed to \code{mclogit.control} or  \code{mmclogit.control}
 #'
 #' @return   \code{mblogit} returns an object of class "mblogit", which has almost the
 #' same structure as an object of class "\link[stats]{glm}". The difference are

diff --git a/pkg/man/mblogit.Rd b/pkg/man/mblogit.Rd
diff --git a/pkg/man/mclogit.Rd b/pkg/man/mclogit.Rd
@@ -32,7 +32,9 @@ mclogit(formula, data=parent.frame(), random=NULL,
         subset, weights = NULL, offset=NULL, na.action = getOption("na.action"),
         model = TRUE, x = FALSE, y = TRUE, contrasts=NULL,
         start=NULL,
-        control=mclogit.control(\dots), \dots)
+        control=if(length(random))
+                    mmclogit.control(\dots)
+                else mclogit.control(\dots), \dots)
 }
 \arguments{
   \item{formula}{a model formula: a symbolic description of the
@@ -96,7 +98,7 @@ mclogit(formula, data=parent.frame(), random=NULL,
     See \code{\link{mclogit.control}} }
 
   \item{\dots}{
-    arguments to be passed to \code{mclogit.control}
+    arguments to be passed to \code{mclogit.control} or \code{mmclogit.control}
     }
 
 }
@@ -142,4 +144,4 @@ summary(mclogit(
   data=within(electors,party.time<-interaction(party,time))))
 }
 \keyword{models}
-\keyword{regression}
+\keyword{regression}
diff --git a/pkg/man/mclogit.fit.Rd b/pkg/man/mclogit.fit.Rd
@@ -11,16 +11,15 @@
 \usage{
 mclogit.fit(y, s, w, X, start = NULL, offset = NULL, control = mclogit.control())
 
-mmclogit.fitPQL(y, s, w, X, Z, G, groups, start,
-                  offset = NULL, control = mclogit.control())
+mmclogit.fitPQL(y, s, w, X, Z, groups, start,
+                  offset = NULL, control = mmclogit.control())
 }
 \arguments{
   \item{y}{a response vector. Should be binary.}
   \item{s}{a vector identifying individuals or covariate strata}
   \item{w}{a vector with observation weights.}
   \item{X}{a model matrix; required.}
   \item{Z}{the random effects design matrix.}
-  \item{G}{a list of design matrices for the (co-)variance parameters.}
   \item{groups}{a list of grouping factors.}
   \item{start}{an optional numerical vector of starting values
     for the coefficients.

diff --git a/pkg/man/mclogit_control.Rd b/pkg/man/mclogit_control.Rd
@@ -1,5 +1,6 @@
 \name{mclogit.control}
 \alias{mclogit.control}
+\alias{mmclogit.control}
 
 \title{Control Parameters for the Fitting Process}
 \description{
@@ -9,6 +10,9 @@
 \usage{
 mclogit.control(epsilon = 1e-08,
                 maxit = 25, trace=TRUE)
+mmclogit.control(epsilon = 1e-08,
+                 maxit = 25, trace=TRUE,
+                 trace.inner=FALSE)
 }
 \arguments{
    \item{epsilon}{positive convergence tolerance \eqn{\epsilon};
@@ -17,6 +21,8 @@ mclogit.control(epsilon = 1e-08,
    \item{maxit}{integer giving the maximal number of IWLS or PQL iterations.}
    \item{trace}{logical indicating if output should be produced for each
     iteration.}
+   \item{trace.inner}{logical indicating if output should be produced for each
+    inner iteration of the PQL method.}
 }
 \value{
   A list.