mcmcr (version 0.2.0)

converged: Object Converged

Description

Test whether an object has converged.

Usage

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

Arguments

x

An object.

...

Unused.

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 values as a data frame versus a named list.

bound

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

Methods (by class)

• default: Test whether an object has converged

• mcmcrs: Test whether an mcmcrs object has converged

See Also

rhat and esr

Examples

# NOT RUN {
converged(mcmcr_example)
converged(mcmcrs(mcmcr_example, mcmcr_example))
converged(mcmcrs(mcmcr_example, mcmcr_example), bound = TRUE)
# }