extract_variable_matrix: Extract matrix of a single variable

In posterior: Tools for Working with Posterior Distributions

Extract matrix of a single variable

Description

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

Usage

extract_variable_matrix(x, variable, ...)

## Default S3 method:
extract_variable_matrix(x, variable, ...)

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

## S3 method for class '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.
...	Arguments passed to individual methods (if applicable).

Value

A matrix with dimension iterations x chains.

Examples

x <- example_draws()
mu <- extract_variable_matrix(x, variable = "mu")
dim(mu)
rhat(mu)

posterior documentation built on Nov. 2, 2023, 5:56 p.m.