R/effective_sample_sizes.R
relative_eff.Rd
relative_eff()
computes the the MCMC effective sample size divided by
the total sample size.
relative_eff(x, ...) # S3 method for default relative_eff(x, chain_id, ...) # S3 method for matrix relative_eff(x, chain_id, ..., cores = getOption("mc.cores", 1)) # S3 method for array relative_eff(x, ..., cores = getOption("mc.cores", 1)) # S3 method for `function` relative_eff( x, chain_id, ..., cores = getOption("mc.cores", 1), data = NULL, draws = NULL ) # S3 method for importance_sampling relative_eff(x, ...)
x  A vector, matrix, 3D array, or function. See the Methods (by
class) section below for details on specifying


chain_id  A vector of length 
cores  The number of cores to use for parallelization. 
data, draws, ...  Same as for the 
A vector of relative effective sample sizes.
default
: A vector of length \(S\) (posterior sample size).
matrix
: An \(S\) by \(N\) matrix, where \(S\) is the size
of the posterior sample (with all chains merged) and \(N\) is the number
of data points.
array
: An \(I\) by \(C\) by \(N\) array, where \(I\)
is the number of MCMC iterations per chain, \(C\) is the number of
chains, and \(N\) is the number of data points.
function
: A function f()
that takes arguments data_i
and draws
and returns a
vector containing the loglikelihood for a single observation i
evaluated
at each posterior draw. The function should be written such that, for each
observation i
in 1:N
, evaluating
f(data_i = data[i,, drop=FALSE], draws = draws)
results in a vector of length S
(size of posterior sample). The
loglikelihood function can also have additional arguments but data_i
and
draws
are required.
If using the function method then the arguments data
and draws
must also
be specified in the call to loo()
:
data
: A data frame or matrix containing the data (e.g.
observed outcome and predictors) needed to compute the pointwise
loglikelihood. For each observation i
, the i
th row of
data
will be passed to the data_i
argument of the
loglikelihood function.
draws
: An object containing the posterior draws for any
parameters needed to compute the pointwise loglikelihood. Unlike
data
, which is indexed by observation, for each observation the
entire object draws
will be passed to the draws
argument of
the loglikelihood function.
The ...
can be used if your loglikelihood function takes additional
arguments. These arguments are used like the draws
argument in that they
are recycled for each observation.
importance_sampling
: If x
is an object of class "psis"
, relative_eff()
simply returns
the r_eff
attribute of x
.
#> [1] 500 2 32#> [1] 1000 32rel_n_eff_1 < relative_eff(exp(LLarr)) rel_n_eff_2 < relative_eff(exp(LLmat), chain_id = rep(1:2, each = 500)) all.equal(rel_n_eff_1, rel_n_eff_2)#> [1] TRUE