# ess_mean: Effective sample size for the mean In posterior: Tools for Working with Posterior Distributions

## Description

Compute an effective sample size estimate for a mean (expectation) estimate of a single variable.

## Usage

 ```1 2 3 4``` ```ess_mean(x, ...) ## S3 method for class 'rvar' ess_mean(x, ...) ```

## Arguments

 `x` (multiple options) One of: A matrix of draws for a single variable (iterations x chains). See `extract_variable_matrix()`. An `rvar`. `...` Arguments passed to individual methods (if applicable).

## Value

If the input is an array, returns a single numeric value. If any of the draws is non-finite, 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.

## References

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.

## Examples

 ```1 2 3 4 5``` ```mu <- extract_variable_matrix(example_draws(), "mu") ess_mean(mu) d <- as_draws_rvars(example_draws("multi_normal")) ess_mean(d\$Sigma) ```

posterior documentation built on Sept. 9, 2021, 5:07 p.m.