egf_has_converged: Test for Convergence

In davidearn/epigrowthfit: Nonlinear Mixed Effects Models of Epidemic Growth

Test for Convergence

Description

Performs simple diagnostic tests to assess whether the optimizer that produced an estimated model actually converged to a local minimum point of the negative log marginal likelihood function.

Usage

egf_has_converged(object, check = TRUE, tol = 1)

Arguments

object	an egf object.
check	a logical. If TRUE, then an error is thrown if object does not actually inherit from class egf.
tol	a positive number. Convergence requires all gradient elements to be less than or equal to tol in absolute value.

Value

TRUE if all tests pass. FALSE if any test fails. NA if no test fails, but the test for a positive definite Hessian matrix is indeterminate because the matrix has not been computed.

davidearn/epigrowthfit documentation built on Feb. 22, 2025, 12:44 p.m.