From 980a4607c6b329b8b1785ad59a46d995238aed6d Mon Sep 17 00:00:00 2001 From: philchalmers Date: Fri, 16 Aug 2024 11:24:47 -0400 Subject: [PATCH] fix doc order --- R/SimSolve.R | 6 +++--- man/SimSolve.Rd | 56 ++++++++++++++++++++++++------------------------- 2 files changed, 31 insertions(+), 31 deletions(-) diff --git a/R/SimSolve.R b/R/SimSolve.R index 5091b150..a38c64bb 100644 --- a/R/SimSolve.R +++ b/R/SimSolve.R @@ -116,9 +116,6 @@ #' is consistently between [.795, .805] then \code{predCI.tol = .01} to indicate this #' tolerance range #' -#' @param control a \code{list} of the algorithm control parameters. If not specified, -#' the defaults described below are used. -#' #' @param wait.time (optional) argument passed to \code{\link{PBA}} to indicate #' the time to wait (specified in minutes) per row in the \code{Design} object #' rather than using pre-determined termination criteria based on the estimates. @@ -129,6 +126,9 @@ #' \code{maxiter} is still used alongside \code{wait.time}, therefore this should #' be increased as well (e.g., to \code{maxiter = 1000}) #' +#' @param control a \code{list} of the algorithm control parameters. If not specified, +#' the defaults described below are used. +#' #' \describe{ #' \item{\code{tol}}{tolerance criteria for early termination (.1 for #' \code{integer = TRUE} searches; .00025 for non-integer searches} diff --git a/man/SimSolve.Rd b/man/SimSolve.Rd index f08c6585..710cba4b 100644 --- a/man/SimSolve.Rd +++ b/man/SimSolve.Rd @@ -130,14 +130,34 @@ vector of length \code{maxiter} to indicate the replications to use per iteration} \item{wait.time}{(optional) argument passed to \code{\link{PBA}} to indicate - the time to wait (specified in minutes) per row in the \code{Design} object - rather than using pre-determined termination criteria based on the estimates. - For example, if three three conditions were defined in - \code{Design}, and \code{wait.time="5"}, - then the total search time till terminate after 15 minutes regardless of - independently specified termination criteria in \code{control}. Note that - \code{maxiter} is still used alongside \code{wait.time}, therefore this should - be increased as well (e.g., to \code{maxiter = 1000}) +the time to wait (specified in minutes) per row in the \code{Design} object +rather than using pre-determined termination criteria based on the estimates. +For example, if three three conditions were defined in +\code{Design}, and \code{wait.time="5"}, +then the total search time till terminate after 15 minutes regardless of +independently specified termination criteria in \code{control}. Note that +\code{maxiter} is still used alongside \code{wait.time}, therefore this should +be increased as well (e.g., to \code{maxiter = 1000})} + +\item{ncores}{see \code{\link{runSimulation}}} + +\item{type}{type of cluster object to define. If \code{type} used in \code{plot} +then can be \code{'density'} to plot the density of the iteration history +after the burn-in stage, \code{'iterations'} for a bubble plot with inverse +replication weights. If not specified then the default PBA +plots are provided (see \code{\link{PBA}})} + +\item{maxiter}{the maximum number of iterations (default 100)} + +\item{check.interval}{logical; should an initial check be made to determine +whether \code{f(interval[1L])} and \code{f(interval[2L])} have opposite +signs? If \code{FALSE}, the specified \code{interval} is assumed to contain a root, +where \code{f(interval[1]) < 0} and \code{f(interval[2] > 0}. Default is \code{TRUE}} + +\item{verbose}{logical; print information to the console?} + +\item{control}{a \code{list} of the algorithm control parameters. If not specified, + the defaults described below are used. \describe{ \item{\code{tol}}{tolerance criteria for early termination (.1 for @@ -161,26 +181,6 @@ iteration} results from \code{Analyse} give less meaningful information} }} -\item{ncores}{see \code{\link{runSimulation}}} - -\item{type}{type of cluster object to define. If \code{type} used in \code{plot} -then can be \code{'density'} to plot the density of the iteration history -after the burn-in stage, \code{'iterations'} for a bubble plot with inverse -replication weights. If not specified then the default PBA -plots are provided (see \code{\link{PBA}})} - -\item{maxiter}{the maximum number of iterations (default 100)} - -\item{check.interval}{logical; should an initial check be made to determine -whether \code{f(interval[1L])} and \code{f(interval[2L])} have opposite -signs? If \code{FALSE}, the specified \code{interval} is assumed to contain a root, -where \code{f(interval[1]) < 0} and \code{f(interval[2] > 0}. Default is \code{TRUE}} - -\item{verbose}{logical; print information to the console?} - -\item{control}{a \code{list} of the algorithm control parameters. If not specified, -the defaults described below are used.} - \item{predCI}{advertised confidence interval probability for final model-based prediction of target \code{b} given the root input estimate. Returned as an element in the \code{summary()} list output}