R/GENMETA.control.R

In 28pro92/packages-GENMETA: Implements Generalized Meta-Analysis

#' Auxiliary for controlling the IRWLS algorithm
#'
#' This is an auxiliary function for the iteratively reweighted least squares algorithm for GENMETA.
#' This is used internally by the myoptim function, but can be used by the user to create a control argument in the GENMETA function
#' @param epsilon a positive numeric indicating converegence tolerence; the algorithm stops when the absolute difference between the estimates in current and previous step is less than epsilon, i.e, \eqn{|estimate_{new} - estimate_{old}| < \epsilon}
#' @param maxit a positive number indicating the maximum number of iterations to be used in the algorithm. Default is 1000.
#' @return A list with components named as the arguments.
#' @examples
#' control <- GENMETA.control(1e-08, 100)
#' @export
GENMETA.control <- function(epsilon = 1e-06, maxit = 1000)
{
  return(list(epsilon = epsilon, maxit = maxit))
}