universals (version 0.0.1)

rhat: R-hat

Description

Calculates an R-hat (potential scale reduction factor) value.

Usage

rhat(x, ...)

Arguments

x

An object.

...

Other arguments passed to methods.

Value

A number >= 1 indicating the rhat value.

Details

By default the uncorrected, unfolded, univariate, split R-hat value.

References

Gelman, A., and Rubin, D.B. 1992. Inference from Iterative Simulation Using Multiple Sequences. Statistical Science 7(4): 457<U+2013>472.

See Also

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

Examples

# NOT RUN {
rhat.foobar <- function(x, ...) {
  NotYetImplemented()
  # replace with code to get rhat for an object of class 'foobar'
}
# }