R/convergence.R

In rsae: Robust Small Area Estimation

convergence <- function(object)
{
    if (!inherits(object, "fit_model_b"))
        stop("Method 'convergence()' is not applicable\n", call. = FALSE)
    saemodel <- attr(object, "saemodel")
    # retrieve the estimating method
    method <- attr(object, "method")
    cat("CONVERGENCE REPORT\n")
    # check whether the model converged
    if (object$converged != 1)
        cat("NOTE: ALGORITHM DID NOT CONVERGE!\n")

    #----------------------
    # niter and acc specification
    optim <- attr(object, "optim")

    # 100 is the max value defined in estimation of "d"
    niter <- c(optim$niter, 100)
    together <- cbind(niter, optim$acc)
    colnames(together) <- c("niter", "acc")
    rownames(together) <- c("overall loop", "fixeff", "residual var",
        "area raneff var")
    cat(paste0("---\nUser specified number of iterations (niter) and\n",
        "numeric precision (acc):\n\n"))
    print(together)

    #----------------------
    # used iters
    iters <- optim$usediter
    iters <- iters[rowSums(iters) != 0, , drop = FALSE]
    colnames(iters) <- c("fixeff", "residual var", "area raneff var")
    rownames(iters) <- 1:NROW(iters)
    cat(paste0("---\nNumber of EE-specific iterations in each call\n",
        "(given the user-defined specs), reported for\n",
        "each of the", NROW(iters), "overall iterations:\n\n"))
    print(iters)
}