Bar charts for categorical data with statistical details included in the plot as a subtitle.
ggbarstats(data, main, condition = NULL, counts = NULL, ratio = NULL,
paired = FALSE, labels.legend = NULL, results.subtitle = TRUE,
stat.title = NULL, sample.size.label = TRUE, label.separator = " ",
label.text.size = 4, label.fill.color = "white",
label.fill.alpha = 1, bar.outline.color = "black",
bf.message = TRUE, sampling.plan = "indepMulti",
fixed.margin = "rows", prior.concentration = 1, title = NULL,
subtitle = NULL, caption = NULL, legend.position = "right",
x.axis.orientation = NULL, conf.level = 0.95, nboot = 100,
simulate.p.value = FALSE, B = 2000, legend.title = NULL,
xlab = NULL, ylab = "Percent", k = 2, perc.k = 0,
bar.label = "percentage", data.label = NULL, bar.proptest = TRUE,
ggtheme = ggplot2::theme_bw(), ggstatsplot.layer = TRUE,
package = "RColorBrewer", palette = "Dark2", direction = 1,
ggplot.component = NULL, return = "plot", messages = TRUE)A dataframe (or a tibble) from which variables specified are to be taken. A matrix or tables will not be accepted.
The variable to use as the rows in the contingency table.
The variable to use as the columns in the contingency table.
A string naming a variable in data containing counts, or NULL
if each row represents a single observation (Default).
A vector of numbers: the expected proportions for the proportion
test. Default is NULL, which means if there are two levels ratio = c(1,1), etc.
Logical indicating whether data came from a within-subjects
design study (Default: FALSE). If TRUE, McNemar test subtitle will be
returned. If FALSE, Pearson's chi-square test will be returned.
A character vector with custom labels for levels of
the main variable displayed in the legend.
Decides whether the results of statistical tests are
to be displayed as a subtitle (Default: TRUE). If set to FALSE, only
the plot will be returned.
Title for the effect being investigated with the chi-square
test. The default is NULL, i.e. no title will be added to describe the
effect being shown. An example of a stat.title argument will be something
like "main x condition" or "interaction".
Logical that decides whether sample size information
should be displayed for each level of the grouping variable condition
(Default: TRUE).
If "both" counts and proportion information is to be
displayed in a label, this argument decides whether these two pieces of
information are going to be on the same line (" ") or on separate lines
("\n").
Numeric that decides text size for slice/bar labels
(Default: 4).
Character that specifies fill color for slice/bar
labels (Default: white).
Numeric that specifies fill color transparency or
"alpha" for slice/bar labels (Default: 1 range 0 to 1).
Character specifying color for bars (default:
"black").
Logical that decides whether to display a caption with
results from bayes factor test in favor of the null hypothesis (default:
FALSE).
Character describing the sampling plan. Possible options
are "indepMulti" (independent multinomial; default), "poisson",
"jointMulti" (joint multinomial), "hypergeom" (hypergeometric). For
more, see ?BayesFactor::contingencyTableBF().
For the independent multinomial sampling plan, which
margin is fixed ("rows" or "cols"). Defaults to "rows".
Specifies the prior concentration parameter, set
to 1 by default. It indexes the expected deviation from the null
hypothesis under the alternative, and corresponds to Gunel and Dickey's
(1974) "a" parameter.
The text for the plot title.
The text for the plot subtitle. Will work only if
results.subtitle = FALSE.
The text for the plot caption.
The position of the legend
"none", "left", "right", "bottom", "top" (Default: "right").
The orientation of the x axis labels one of
"slant" or "vertical" to change from the default horizontal
orientation (Default: NULL which is horizontal).
Scalar between 0 and 1. If unspecified, the defaults return
95% lower and upper confidence intervals (0.95).
Number of bootstrap samples for computing confidence interval
for the effect size (Default: 100).
a logical indicating whether to compute p-values by Monte Carlo simulation.
an integer specifying the number of replicates used in the Monte Carlo test.
Title text for the legend.
Custom text for the x axis label (Default: NULL, which
will cause the x axis label to be the main variable).
Custom text for the y axis label (Default: "percent").
Number of digits after decimal point (should be an integer)
(Default: k = 2).
Numeric that decides number of decimal places for percentage
labels (Default: 0).
Character decides what information needs to be
displayed on the label in each pie slice. Possible options are
"percentage" (default), "counts", "both".
Decides whether proportion test for main variable is
to be carried out for each level of condition (Default: TRUE).
A function, ggplot2 theme name. Default value is
ggplot2::theme_bw(). Any of the ggplot2 themes, or themes from
extension packages are allowed (e.g., ggthemes::theme_fivethirtyeight(),
hrbrthemes::theme_ipsum_ps(), etc.).
Logical that decides whether theme_ggstatsplot
theme elements are to be displayed along with the selected ggtheme
(Default: TRUE).
Name of package from which the palette is desired as string or symbol.
If a character string (e.g., "Set1"), will use that named
palette. If a number, will index into the list of palettes of appropriate
type. Default palette is "Dark2".
Either 1 or -1. If -1 the palette will be reversed.
A ggplot component to be added to the plot prepared
by ggstatsplot. This argument is primarily helpful for grouped_ variant
of the current function. Default is NULL. The argument should be entered
as a function. If the given function has an argument axes.range.restrict
and if it has been set to TRUE, the added ggplot component might not
work as expected.
Character that describes what is to be returned: can be
"plot" (default) or "subtitle" or "caption". Setting this to
"subtitle" will return the expression containing statistical results,
which will be a NULL if you set results.subtitle = FALSE. Setting this
to "caption" will return the expression containing details about Bayes
Factor analysis, but valid only when type = "p" and bf.message = TRUE,
otherwise this will return a NULL.
Decides whether messages references, notes, and warnings are
to be displayed (Default: TRUE).
Unlike a number of statistical softwares, ggstatsplot doesn't
provide the option for Yates' correction for the Pearson's chi-squared
statistic. This is due to compelling amount of Monte-Carlo simulation
research which suggests that the Yates' correction is overly conservative,
even in small sample sizes. As such it is recommended that it should not
ever be applied in practice (Camilli & Hopkins, 1978, 1979; Feinberg, 1980;
Larntz, 1978; Thompson, 1988).
For more about how the effect size measures and their confidence intervals
are computed, see ?rcompanion::cohenG, ?rcompanion::cramerV, and
?rcompanion::cramerVFit.
# NOT RUN {
# for reproducibility
set.seed(123)
# simple function call with the defaults (with condition)
ggstatsplot::ggbarstats(
data = datasets::mtcars,
main = vs,
condition = cyl,
nboot = 10,
labels.legend = c("0 = V-shaped", "1 = straight"),
legend.title = "Engine"
)
# }
# NOT RUN {
# simple function call with the defaults (with count data)
library(jmv)
ggstatsplot::ggbarstats(
data = as.data.frame(HairEyeColor),
main = Eye,
condition = Hair,
counts = Freq
)
# }
Run the code above in your browser using DataLab