summary.bayesMig.convergence: Summary of Convergence Diagnostics

View source: R/get_outputs.R

summary.bayesMig.convergenceR Documentation

Summary of Convergence Diagnostics

Description

Summary of an object of class bayesMig.convergence created using the mig.diagnose function. It gives an overview about parameters that did not converge.

Usage

## S3 method for class 'bayesMig.convergence'
summary(object, expand = FALSE, ...)

Arguments

object

Object of class bayesMig.prediction.

expand

By default, the function does not show country-specific parameters for which there was no convergence (only country-independent parameters), if the status is ‘red’. This argument can switch that option on.

...

Not used.

Value

List with items that summarize an object of class bayesMig.convergence.


bayesMig documentation built on April 3, 2025, 8:59 p.m.