Convergence status for a drmTMB fit

convergence_status() returns a short character label for programmatic workflows that need more detail than is_converged(). A fit can report optimizer code 0 while the likelihood geometry is degenerate (no proper maximum or non-finite uncertainty); such fits return "degenerate" even when multi_start selected among several starts. "boundary" marks an optimizer-converged fit with variance-component or residual-correlation parameters near an interpretability boundary. is_converged() stays a plain logical: it is TRUE for "converged" and "boundary", and FALSE for "degenerate".

Usage

convergence_status(object, ...)

# Default S3 method
convergence_status(object, ...)

# S3 method for class 'drmTMB'
convergence_status(object, ...)

Arguments

object

A drmTMB fit.

...

Reserved for future options.

Value

One of "converged", "boundary", or "degenerate".

Examples

set.seed(20260916)
dat <- data.frame(y = rnorm(40), x = rnorm(40))
fit <- drmTMB(bf(y ~ x, sigma ~ 1), data = dat)
convergence_status(fit)
#> [1] "converged"