Description Usage Arguments Value References See Also Examples
Compute the basic effective sample size (ESS) estimate for a single variable
as described in Gelman et al. (2013). For practical applications, we strongly
recommend the improved ESS convergence diagnostics implemented in
ess_bulk()
and ess_tail()
.
1 2 3 4 5 6 7 
x 
(multiple options) One of:

... 
Arguments passed to individual methods (if applicable). 
split 
(logical) Should the estimate be computed on split chains? The
default is 
If the input is an array, returns a single numeric value. If any of the draws
is nonfinite, that is, NA
, NaN
, Inf
, or Inf
, the returned output
will be (numeric) NA
. Also, if all draws within any of the chains of a
variable are the same (constant), the returned output will be (numeric) NA
as well. The reason for the latter is that, for constant draws, we cannot
distinguish between variables that are supposed to be constant (e.g., a
diagonal element of a correlation matrix is always 1) or variables that just
happened to be constant because of a failure of convergence or other problems
in the sampling process.
If the input is an rvar
, returns an array of the same dimensions as the
rvar
, where each element is equal to the value that would be returned by
passing the draws array for that element of the rvar
to this function.
Andrew Gelman, John B. Carlin, Hal S. Stern, David B. Dunson, Aki Vehtari and Donald B. Rubin (2013). Bayesian Data Analysis, Third Edition. Chapman and Hall/CRC.
Other diagnostics:
ess_bulk()
,
ess_quantile()
,
ess_sd()
,
ess_tail()
,
mcse_mean()
,
mcse_quantile()
,
mcse_sd()
,
rhat_basic()
,
rhat()
,
rstar()
1 2 3 4 5  mu < extract_variable_matrix(example_draws(), "mu")
ess_basic(mu)
d < as_draws_rvars(example_draws("multi_normal"))
ess_basic(d$Sigma)

Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.