Skip to content

Commit

Permalink
Add missing documentation of arguments.
Browse files Browse the repository at this point in the history
  • Loading branch information
melff committed Oct 5, 2024
1 parent 1c3d5ee commit 920ec97
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 1 deletion.
1 change: 1 addition & 0 deletions pkg/R/mclogit-rebase.R
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ rebase_mat <- function(categs,from,to){
#'
#' @param object a statistical model object
#' @param to usually, a string; the baseline category
#' @param ... other arguments, currently ignored
rebase <- function(object,to,...) UseMethod("rebase")

#' @rdname rebase
Expand Down
18 changes: 17 additions & 1 deletion pkg/man/mclogit_control.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,12 @@ mmclogit.control(epsilon = 1e-08,
NM.beta = 0.5,
NM.gamma = 2.0,
SANN.temp = 10,
SANN.tmax = 10)
SANN.tmax = 10,
grtol = 1e-6,
xtol = 1e-8,
maxeval = 100,
gradstep = c(1e-6, 1e-8),
use.gradient = c("analytic","numeric"))
}
\arguments{
\item{epsilon}{positive convergence tolerance \eqn{\epsilon};
Expand Down Expand Up @@ -71,6 +76,17 @@ mmclogit.control(epsilon = 1e-08,
\item{SANN.tmax}{integer; the \code{tmax} argument passed to
\code{\link{optim}} if
"SANN" is selected as inner optimizer.}
\item{grtol}{numeric; the \code{grtol} control parameter
for \code{ucminf} if "ucminf" is selected as inner optimizer.}
\item{xtol}{numeric; the \code{xtol} control parameter
for \code{ucminf} if "ucminf" is selected as inner optimizer.}
\item{maxeval}{integer; the \code{maxeval} control parameter
for \code{ucminf} if "ucminf" is selected as inner optimizer.}
\item{gradstep}{a numeric vector of length; the \code{gradstep} control parameter
for \code{ucminf} if "ucminf" is selected as inner optimizer.}
\item{use.gradient}{a character string; whether the gradient should
be computed analytically or whether a finite-difference approximation
should be used.}
}
\value{
A list.
Expand Down
2 changes: 2 additions & 0 deletions pkg/man/rebase.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 920ec97

Please sign in to comment.