| ggbarstats | R Documentation |
Bar charts for categorical data with statistical details included in the plot as a subtitle.
ggbarstats(
data,
x,
y = NULL,
counts = NULL,
type = "parametric",
paired = FALSE,
results.subtitle = TRUE,
label = "percentage",
label.args = list(alpha = 1, fill = "white"),
sample.size.label.args = list(size = 4),
digits = 2L,
proportion.test = results.subtitle,
digits.perc = 0L,
bf.message = TRUE,
ratio = NULL,
alternative = "two.sided",
conf.level = 0.95,
p.adjust.method = "holm",
title = NULL,
subtitle = NULL,
caption = NULL,
legend.title = NULL,
xlab = NULL,
ylab = NULL,
ggtheme = ggstatsplot::theme_ggstatsplot(),
palette = "ggthemes::gdoc",
ggplot.component = NULL,
...
)
data |
A data frame (or a tibble) from which variables specified are to
be taken. Other data types (e.g., matrix,table, array, etc.) will not
be accepted. Additionally, grouped data frames from |
x |
The variable to use as the rows in the contingency table. Please note that if there are empty factor levels in your variable, they will be dropped. |
y |
The variable to use as the columns in the contingency table.
Please note that if there are empty factor levels in your variable, they
will be dropped. Default is |
counts |
The variable in data containing counts, or |
type |
A character specifying the type of statistical approach:
You can specify just the initial letter. |
paired |
Logical indicating whether data came from a within-subjects or
repeated measures design study (Default: |
results.subtitle |
Decides whether the results of statistical tests are
to be displayed as a subtitle (Default: |
label |
Character decides what information needs to be displayed
on the label in each pie slice. Possible options are |
label.args |
Additional aesthetic arguments that will be passed to
|
sample.size.label.args |
Additional aesthetic arguments that will be
passed to |
digits |
Number of digits for rounding or significant figures. May also
be |
proportion.test |
Decides whether proportion test for |
digits.perc |
Numeric that decides number of decimal places for
percentage labels (Default: |
bf.message |
Logical that decides whether to display Bayes Factor in
favor of the null hypothesis. This argument is relevant only for
parametric test (Default: |
ratio |
A vector of proportions: the expected proportions for the
proportion test (should sum to |
alternative |
a character string specifying the alternative
hypothesis, must be one of |
conf.level |
Scalar between |
p.adjust.method |
Adjustment method for p-values for multiple
comparisons. Possible methods are: |
title |
The text for the plot title. |
subtitle |
The text for the plot subtitle. Will work only if
|
caption |
The text for the plot caption. This argument is relevant only
if |
legend.title |
Title text for the legend. |
xlab |
Label for |
ylab |
Labels for |
ggtheme |
A |
palette |
Name of the palette in |
ggplot.component |
A |
... |
Currently ignored. |
For details, see: https://www.indrapatil.com/ggstatsplot/articles/web_only/ggpiestats.html
| graphical element | geom used | argument for further modification |
| bars | ggplot2::geom_bar() | NA |
| descriptive labels | ggplot2::geom_label() | label.args |
| sample size labels | ggplot2::geom_text() | sample.size.label.args |
The table below provides summary about:
statistical test carried out for inferential statistics
type of effect size estimate and a measure of uncertainty for this estimate
functions used internally to compute these details
Hypothesis testing
| Type | Design | Test | Function used |
| Parametric/Non-parametric | Unpaired | Pearson's chi-squared test | stats::chisq.test() |
| Bayesian | Unpaired | Bayesian Pearson's chi-squared test | BayesFactor::contingencyTableBF() |
| Parametric/Non-parametric | Paired | McNemar's chi-squared test | stats::mcnemar.test() |
| Bayesian | Paired | No | No |
Effect size estimation
| Type | Design | Effect size | CI available? | Function used |
| Parametric/Non-parametric | Unpaired | Cramer's V | Yes | effectsize::cramers_v() |
| Bayesian | Unpaired | Cramer's V | Yes | effectsize::cramers_v() |
| Parametric/Non-parametric | Paired | Cohen's g | Yes | effectsize::cohens_g() |
| Bayesian | Paired | No | No | No |
Hypothesis testing
| Type | Test | Function used |
| Parametric/Non-parametric | Goodness of fit chi-squared test | stats::chisq.test() |
| Bayesian | Bayesian Goodness of fit chi-squared test | (custom) |
Effect size estimation
| Type | Effect size | CI available? | Function used |
| Parametric/Non-parametric | Pearson's C | Yes | effectsize::pearsons_c() |
| Bayesian | No | No | No |
When there is a two-way table and x has more than two levels, pairwise
contingency table analyses (Fisher's exact tests) are computed using
statsExpressions::pairwise_contingency_table(). These pairwise results are not
displayed in the plot because bar and pie charts lack a natural visual
representation for pairwise significance annotations (unlike box/violin
plots, which use bracket annotations). Additionally, there is no
established convention for overlaying pairwise comparisons on pie charts,
and both ggpiestats() and ggbarstats() are designed to remain visually
congruent. The pairwise results are available as a data frame via
extract_stats(plot)$pairwise_comparisons_data.
grouped_ggbarstats, ggpiestats,
grouped_ggpiestats
# for reproducibility
set.seed(123)
# one sample goodness of fit proportion test
p <- ggbarstats(mtcars, vs)
# looking at the plot
p
# extracting details from statistical tests
extract_stats(p)
# association test (or contingency table analysis)
ggbarstats(mtcars, vs, cyl)
# with 3+ x levels, pairwise comparisons are available
ggbarstats(mtcars, cyl, am)
# Bayesian test
ggbarstats(mtcars, vs, cyl, type = "bayes")
# using pre-aggregated data with counts
ggbarstats(as.data.frame(Titanic), x = Survived, y = Sex, counts = Freq)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.