Extract matrix of a single variable

Extract an iterations x chains matrix of draws of a single variable. This is primarily used for convergence diagnostic functions such as rhat().

extract_variable_matrix(x, variable, ...)

# S3 method for default
extract_variable_matrix(x, variable, ...)

# S3 method for draws
extract_variable_matrix(x, variable, ...)

# S3 method for draws_df
extract_variable_matrix(x, variable, ...)

# S3 method for draws_list
extract_variable_matrix(x, variable, ...)

# S3 method for draws_rvars
extract_variable_matrix(x, variable, ...)

Arguments

x

(draws) A draws object or another R object for which the method is defined.

variable

(string) The name of the variable to extract. Must include indices for array variables (e.g. "x[1]", "y[1,2]"). To extract all dimensions from variables with indices, use extract_variable_array().

...

Arguments passed to individual methods (if applicable).

Value

A matrix with dimension iterations x chains.

See also

Other variable extraction methods: extract_variable(), extract_variable_array()

Examples

x <- example_draws()
mu <- extract_variable_matrix(x, variable = "mu")
dim(mu)
#> [1] 100   4
rhat(mu)
#> [1] 1.021923