extract_stats: Extracting data frames or expressions from '{ggstatsplot}'...

In ggstatsplot: 'ggplot2' Based Plots with Statistical Details

Extracting data frames or expressions from {ggstatsplot} plots

Description

Extracting data frames or expressions from {ggstatsplot} plots

Usage

extract_stats(p)

extract_subtitle(p)

extract_caption(p)

Arguments

p	A plot from {ggstatsplot} package

Details

These helpers retrieve the statistical data frames and expressions retained by {ggstatsplot} plots. If you only need tabular results, call the underlying analysis functions directly: {statsExpressions} for statistical tests, parameters::model_parameters() for model coefficients, and performance::model_performance() for model fit indices.

ggcorrmat() does not retain statistical data frames, so all elements returned by extract_stats() are NULL. Use correlation::correlation() to obtain its statistical results as data.

Value

For extract_stats(), a list with the following elements, each either a data frame or NULL if not relevant for the given plot:

• subtitle_data: results of the test displayed in the subtitle

• caption_data: results of the test displayed in the caption (typically, the Bayesian test)

• pairwise_comparisons_data: results of pairwise comparisons

• descriptive_data: counts and percentages (ggpiestats() and ggbarstats())

• one_sample_data: proportion tests for each level of y (ggpiestats() and ggbarstats())

• tidy_data: tidy model parameters (ggcoefstats())

• glance_data: model performance indices (ggcoefstats())

For extract_subtitle() and extract_caption(), the statistical expression used in the subtitle or caption, respectively (or NULL if unavailable). User-supplied subtitle and caption text is not returned.

For plots from ⁠grouped_*⁠ functions, a list with one such element per plot.

Examples

set.seed(123)

# non-grouped plot
p1 <- ggbetweenstats(mtcars, cyl, mpg)

# grouped plot
p2 <- grouped_ggbarstats(Titanic_full, Survived, Sex, grouping.var = Age)

# extracting expressions -----------------------------

extract_subtitle(p1)
extract_caption(p1)

extract_subtitle(p2)
extract_caption(p2)

# extracting data frames -----------------------------

extract_stats(p1)

extract_stats(p2)

ggstatsplot documentation built on Oct. 18, 2026, 1:07 a.m.