Convergence check

Source: R/AllGenerics.R, R/conv-methods.R

Extracts the convergence status from a model.

# S4 method for CEL
conv(object, ...)

# S4 method for EL
conv(object, ...)

# S4 method for ELT
conv(object, ...)

# S4 method for SummaryEL
conv(object, ...)

# S4 method for SummaryELT
conv(object, ...)

# S4 method for SummaryLM
conv(object, ...)

Arguments

object

An object that contains the convergence status.

...

Further arguments passed to methods.

Value

A single logical.

Methods (by class)

  • conv(CEL): Extracts the convergence status of the model with respect to the parameter.

  • conv(EL): Extracts the convergence status of the model with respect to the Lagrange multiplier.

  • conv(ELT): Extracts the convergence status of the test with respect to the parameter (or the Lagrange multiplier if the argument lhs is NULL).

  • conv(SummaryEL): Extracts the convergence status of the model with respect to the Lagrange multiplier.

  • conv(SummaryELT): Extracts the convergence status of the test with respect to the parameter (or the Lagrange multiplier if the argument lhs is NULL).

  • conv(SummaryLM): Extracts the convergence status of the model. See the documentation of EL and CEL.

See also

CEL, EL, ELT, getOptim()

Examples

## Convergence check for the overall model test
data("mtcars")
fit <- el_lm(mpg ~ ., data = mtcars)
conv(fit)
#> [1] TRUE