A combination of box and violin plots along with jittered data points for between-subjects designs with statistical details included in the plot as a subtitle.
ggbetweenstats(data, x, y, plot.type = "boxviolin",
type = "parametric", effsize.type = "unbiased",
effsize.noncentral = FALSE, bf.prior = 0.707, bf.message = FALSE,
xlab = NULL, ylab = NULL, caption = NULL, title = NULL,
sample.size.label = TRUE, k = 3, var.equal = FALSE, nboot = 100,
tr = 0.1, mean.label.size = 3, mean.label.fontface = "bold",
mean.label.color = "black", notch = FALSE, notchwidth = 0.5,
linetype = "solid", outlier.tagging = FALSE, outlier.label = NULL,
outlier.label.color = "black", outlier.color = "black",
outlier.coef = 1.5, mean.plotting = TRUE, mean.ci = FALSE,
mean.size = 5, mean.color = "darkred",
ggtheme = ggplot2::theme_bw(), ggstatsplot.layer = TRUE,
package = "RColorBrewer", palette = "Dark2", direction = 1,
point.jitter.width = NULL, point.jitter.height = 0.1,
point.dodge.width = 0.6, messages = TRUE)
Dataframe from which variables specified are preferentially to be taken.
The grouping variable.
The response - a vector of length the number of rows of x
.
Character describing the type of plot. Currently supported
plots are "box"
(for pure boxplots), "violin"
(for pure violin plots),
and "boxviolin"
(for a mix of box and violin plots; default).
Type of statistic expected ("parametric"
or "nonparametric"
or "robust"
or "bayes"
).Corresponding abbreviations are also accepted:
"p"
(for parametric), "np"
(nonparametric), "r"
(robust), or
"bf"
resp.
Type of effect size needed for parametric tests. The
argument can be "biased"
("d"
for Cohen's d for t-test;
"partial_eta"
for partial eta-squared for anova) or "unbiased"
("g"
Hedge's g for t-test; "partial_omega"
for partial
omega-squared for anova)).
Logical indicating whether to use non-central
t-distributions for computing the 95
or Hedge's g (Default: FALSE
).
A number between 0.5 and 2 (default 0.707
), the prior width
to use in calculating Bayes factors.
Logical. Decides whether to display Bayes Factor in favor
of null hypothesis for parametric test (Default: bf.message = FALSE
).
Label for x
axis variable.
Label for y
axis variable.
The text for the plot caption.
The text for the plot title.
Logical that decides whether sample size information
should be displayed for each level of the grouping variable x
(Default:
TRUE
).
Number of digits after decimal point (should be an integer) (Default: k = 3
).
a logical variable indicating whether to treat the
variances in the samples as equal. If TRUE
, then a simple F
test for the equality of means in a one-way analysis of variance is
performed. If FALSE
, an approximate method of Welch (1951)
is used, which generalizes the commonly known 2-sample Welch test to
the case of arbitrarily many samples.
Number of bootstrap samples for computing effect size (Default:
100
).
Trim level for the mean when carrying out robust
tests. If you
get error stating "Standard error cannot be computed because of Winsorized
variance of 0 (e.g., due to ties). Try to decrease the trimming level.",
try to play around with the value of tr
, which is by default set to
0.1
. Lowering the value might help.
Aesthetics for
the label displaying mean. Defaults: 3
, "bold"
,"black"
, respectively.
A logical. If FALSE
(default), a standard box plot will be
displayed. If TRUE
, a notched box plot will be used. Notches are used to
compare groups; if the notches of two boxes do not overlap, this suggests
that the medians are significantly different. In a notched box plot, the
notches extend 1.58 * IQR / sqrt(n)
. This gives a roughly 95%
confidence
interval for comparing medians. IQR: Inter-Quartile Range.
For a notched box plot, width of the notch relative to the
body (default 0.5
).
Character strings ("blank"
, "solid"
, "dashed"
,
"dotted"
, "dotdash"
, "longdash"
, and "twodash"
) specifying the type
of line to draw box plots (Default: "solid"
). Alternatively, the numbers
0
to 6
can be used (0
for "blank", 1
for "solid", etc.).
Decides whether outliers should be tagged (Default:
FALSE
).
Label to put on the outliers that have been tagged.
Color for the label to to put on the outliers that
have been tagged (Default: "black"
).
Default aesthetics for outliers (Default: "black"
).
Coefficient for outlier detection using Tukey's method.
With Tukey's method, outliers are below (1st Quartile) or above (3rd
Quartile) outlier.coef
times the Inter-Quartile Range (IQR) (Default:
1.5
).
Logical that decides whether mean is to be highlighted
and its value to be displayed (Default: TRUE
).
Logical that decides whether 95
is to be displayed (Default: FALSE
).
Point size for the data point corresponding to mean
(Default: 5
).
Color for the data point corresponding to mean (Default:
"darkred"
).
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_economist()
,
hrbrthemes::theme_ipsum_ps()
, ggthemes::theme_fivethirtyeight()
, 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.
Numeric specifying the degree of jitter in x
direction. Defaults to 40%
of the resolution of the data.
Numeric specifying the degree of jitter in y
direction. Defaults to 0.1
.
Numeric specifying the amount to dodge in the x
direction. Defaults to 0.60
.
Decides whether messages references, notes, and warnings are
to be displayed (Default: TRUE
).
For parametric tests, Welch's ANOVA/t-test are used as a default. References:
ANOVA: Delacre, Leys, Mora, & Lakens, PsyArXiv, 2018
t-test: Delacre, Lakens, & Leys, International Review of Social Psychology, 2017
If robust tests are selected, following tests are used is .
ANOVA: one-way ANOVA on trimmed means (see ?WRS2::t1way
)
t-test: Yuen's test for trimmed means (see ?WRS2::yuen
)
Variant of this function ggwithinstats
is currently under work. You can
still use this function just to prepare the plot for exploratory data
analysis, but the statistical details displayed in the subtitle will be
incorrect. You can remove them by adding + ggplot2::labs(subtitle = NULL)
.
https://cran.r-project.org/package=ggstatsplot/vignettes/ggbetweenstats.html
# NOT RUN {
# to get reproducible results from bootstrapping
set.seed(123)
# simple function call with the defaults
ggstatsplot::ggbetweenstats(
data = mtcars,
x = am,
y = mpg,
title = "Fuel efficiency by type of car transmission",
caption = "Transmission (0 = automatic, 1 = manual)",
bf.message = TRUE
)
# more detailed function call
ggstatsplot::ggbetweenstats(
data = datasets::morley,
x = Expt,
y = Speed,
plot.type = "box",
xlab = "The experiment number",
ylab = "Speed-of-light measurement",
outlier.tagging = TRUE,
outlier.label = Run,
ggtheme = ggthemes::theme_few(),
ggstatsplot.layer = FALSE
)
# }
Run the code above in your browser using DataLab