Summarize a ferx fit result — summary.ferx

Returns a compact list with the most-used diagnostic fields: model name, dataset, estimation method (including the full chain when multiple methods were chained), OFV/AIC/BIC, parameter estimates, standard errors, shrinkage, effective settings, SIR ESS (when available), warnings, and run metadata. Printing the returned object via print() or auto-printing formats all fields in a human-readable layout.

# S3 method for class 'ferx_fit'
summary(object, ...)

Arguments

object: A ferx_fit object returned by ferx_fit.
...: Ignored.

Value

A ferx_summary list (invisibly). Fields include: model_name, data_name, method, method_chain, gradient, gradient_used, converged, ofv, aic, bic, n_subjects, n_obs, n_parameters, n_iterations, theta, se_theta, omega, se_omega, sigma, se_sigma, shrinkage_eta, shrinkage_eps, covariance_status, eigenvalues, condition_number (see ferx_fit for definitions), wall_time_secs, ferx_version, call_settings, model_file_settings, sir_ess, warnings, ebe_convergence_warnings, max_unconverged_subjects, total_ebe_fallbacks.

Examples

if (FALSE) { # \dontrun{
ex  <- ferx_example("warfarin")
fit <- ferx_fit(ex$model, ex$data)
summary(fit)

# Chained estimation: SAEM warm-start followed by FOCEI refinement
fit_chain <- ferx_fit(ex$model, ex$data, method = c("saem", "focei"))
summary(fit_chain)

# With custom settings — shown in the Settings block
fit_custom <- ferx_fit(ex$model, ex$data,
  settings = list(optimizer = "slsqp", max_iter = 200L))
summary(fit_custom)
} # }