converged.mcmcrs {mcmcr}

Converged

Description

Tests whether an object has converged.

Usage

## S3 method for class 'mcmcrs'
converged(
  x,
  rhat = 1.1,
  esr = 0.33,
  by = "all",
  as_df = FALSE,
  bound = FALSE,
  na_rm = FALSE,
  ...
)

Arguments

x

An object.

rhat

The maximum rhat value.

esr

The minimum effective sampling rate.

by

A string indicating whether to determine by "term", "parameter" or "all".

as_df

A flag indicating whether to return the results as a data frame versus a named list.

bound

flag specifying whether to bind mcmcrs objects by their chains before calculating rhat.

na_rm

A flag specifying whether to ignore missing values.

...

Other arguments passed to methods.

Value

A logical scalar indicating whether the object has converged.

See Also

Other convergence: converged_pars(), converged_terms(), esr_pars(), esr_terms(), esr(), rhat_pars(), rhat_terms(), rhat()

Examples

converged(mcmcrs(mcmcr_example, mcmcr_example))
converged(mcmcrs(mcmcr_example, mcmcr_example), bound = TRUE)