quantile2: Compute Quantiles

In posterior: Tools for Working with Posterior Distributions

Compute Quantiles

Description

Compute quantiles of a sample and return them in a format consistent with other summary functions in the posterior package.

Usage

quantile2(x, probs = c(0.05, 0.95), na.rm = FALSE, ...)

## Default S3 method:
quantile2(x, probs = c(0.05, 0.95), na.rm = FALSE, names = TRUE, ...)

## S3 method for class 'rvar'
quantile2(x, probs = c(0.05, 0.95), na.rm = FALSE, names = TRUE, ...)

Arguments

x	(multiple options) One of: A matrix of draws for a single variable (iterations x chains). See extract_variable_matrix(). An rvar.
probs	(numeric vector) Probabilities in ⁠[0, 1]⁠.
na.rm	(logical) Should NA and NaN values be removed from x prior to computing quantiles? The default is FALSE.
...	Arguments passed to individual methods (if applicable) and then on to stats::quantile().
names	(logical) Should the result have a names attribute? The default is TRUE, but use FALSE for improved speed if there are many values in probs.

Value

A numeric vector of length length(probs). If names = TRUE, it has a names attribute with names like "q5", "q95", etc, based on the values of probs.

Examples

mu <- extract_variable_matrix(example_draws(), "mu")
quantile2(mu)

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