check_rhat: Diagnosis of MCMC sampling

Description Usage Arguments Details Value Author(s) References

View source: R/check_rhat.R

Description

This function evaluate R hat statistics for any fitted model object of class stanfit.

Usage

1
check_rhat(StanS4class, summary = FALSE, digits = 3)

Arguments

StanS4class

An S4 object of class stanfitExtended which is an inherited class from the S4 class stanfit. This R object is a fitted model object as a return value of the function fit_Bayesian_FROC().

To be passed to DrawCurves(), ppp() and ... etc

summary

Logical: TRUE of FALSE. Whether to print the verbose summary. If TRUE then verbose summary is printed in the R console. If FALSE, the output is minimal. I regret, this variable name should be verbose.

digits

a positive integer, indicating the digit of R hat printed in R/R-studio console

Details

It evaluates whether or not r hat statistics are close to 1.

Value

Logical, that is TRUE or FALSE. If model converges then TRUE, and if not FALSE.

Author(s)

betanalpha, so not my function. But I modified it. So, alphanbetan is one of the standeveloper, so his function will has consensus, thus I use it.

References

Gelman A. \& Rubin, D.B. (1992). Inference from Iterative Simulation Using Multiple Sequences, Statistical Science, Volume 7, Number 4, 457-472.


BayesianFROC documentation built on Jan. 13, 2021, 5:22 a.m.