check_mcmc: Diagnostics of the MCMC

View source: R/mcmc.R

check_mcmcR Documentation

Diagnostics of the MCMC

Description

Diagnostics of the MCMC

Usage

check_mcmc(stan_fit, n_draws, threshold_lowESS = 0.4)

Arguments

stan_fit

A stanfit object.

n_draws

Number of MCMC draws.

threshold_lowESS

A number in ⁠[0,1]⁠ indicating the minimum acceptable value of the relative ESS. See details.

Details

Performs checks of the quality of the MCMC. See check_ESS() and check_hmc_diagn() for details.

Value

A warning message in case of detected problems.


rbmi documentation built on Nov. 24, 2023, 5:11 p.m.