R/ggbetweenstats.R
ggbetweenstats.Rd
A combination of box and violin plots along with jittered data points for betweensubjects designs with statistical details included in the plot as a subtitle.
ggbetweenstats( data, x, y, plot.type = "boxviolin", type = "parametric", pairwise.comparisons = TRUE, pairwise.display = "significant", p.adjust.method = "holm", effsize.type = "unbiased", bf.prior = 0.707, bf.message = TRUE, results.subtitle = TRUE, xlab = NULL, ylab = NULL, caption = NULL, title = NULL, subtitle = NULL, k = 2L, var.equal = FALSE, conf.level = 0.95, nboot = 100L, tr = 0.2, centrality.plotting = TRUE, centrality.type = type, centrality.point.args = list(size = 5, color = "darkred"), centrality.label.args = list(size = 3, nudge_x = 0.4, segment.linetype = 4), outlier.tagging = FALSE, outlier.label = NULL, outlier.coef = 1.5, outlier.shape = 19, outlier.color = "black", outlier.label.args = list(size = 3), point.args = list(position = ggplot2::position_jitterdodge(dodge.width = 0.6), alpha = 0.4, size = 3, stroke = 0), violin.args = list(width = 0.5, alpha = 0.2), ggsignif.args = list(textsize = 3, tip_length = 0.01), ggtheme = ggplot2::theme_bw(), ggstatsplot.layer = TRUE, package = "RColorBrewer", palette = "Dark2", ggplot.component = NULL, output = "plot", ... )
data  A dataframe (or a tibble) from which variables specified are to be taken. Other data types (e.g., matrix,table, array, etc.) will not be accepted. 

x  The grouping (or independent) variable from the dataframe 
y  The response (or outcome or dependent) variable from the
dataframe 
plot.type  Character describing the type of plot. Currently supported
plots are 
type  A character specifying the type of statistical approach. Four possible options:
Corresponding abbreviations are also accepted: 
pairwise.comparisons  Logical that decides whether pairwise comparisons
are to be displayed (default: 
pairwise.display  Decides which pairwise comparisons to display. Available options are:
You can use this argument to make sure that your plot is not ubercluttered when you have multiple groups being compared and scores of pairwise comparisons being displayed. 
p.adjust.method  Adjustment method for pvalues for multiple
comparisons. Possible methods are: 
effsize.type  Type of effect size needed for parametric tests. The
argument can be 
bf.prior  A number between 
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: 
results.subtitle  Decides whether the results of statistical tests are
to be displayed as a subtitle (Default: 
xlab, ylab  Labels for 
caption  The text for the plot caption. 
title  The text for the plot title. 
subtitle  The text for the plot subtitle. Will work only if

k  Number of digits after decimal point (should be an integer)
(Default: 
var.equal  a logical variable indicating whether to treat the
two variances as being equal. If 
conf.level  Scalar between 
nboot  Number of bootstrap samples for computing confidence interval
for the effect size (Default: 
tr  Trim level for the mean when carrying out 
centrality.plotting  Logical that decides whether centrality tendency
measure is to be displayed as a point with a label (Default:
If you want default centrality parameter, you can specify this using

centrality.type  Decides which centrality parameter is to be displayed.
The default is to choose the same as
Just as 
centrality.point.args, centrality.label.args  A list of additional aesthetic
arguments to be passed to 
outlier.tagging  Decides whether outliers should be tagged (Default:

outlier.label  Label to put on the outliers that have been tagged. This
can't be the same as 
outlier.coef  Coefficient for outlier detection using Tukey's method.
With Tukey's method, outliers are below (1st Quartile) or above (3rd
Quartile) 
outlier.shape  Hiding the outliers can be achieved by setting

outlier.color  Default aesthetics for outliers (Default: 
outlier.label.args  A list of additional aesthetic arguments to be
passed to 
point.args  A list of additional aesthetic arguments to be passed to
the 
violin.args  A list of additional aesthetic arguments to be passed to
the 
ggsignif.args  A list of additional aesthetic
arguments to be passed to 
ggtheme  A function, 
ggstatsplot.layer  Logical that decides whether 
package, palette  Name of the package from which the given palette is to
be extracted. The available palettes and packages can be checked by running

ggplot.component  A 
output  Character that describes what is to be returned: can be

...  Currently ignored. 
https://indrajeetpatil.github.io/ggstatsplot/articles/web_only/ggbetweenstats.html
# \donttest{ # to get reproducible results from bootstrapping set.seed(123) library(ggstatsplot) # 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)" )# more detailed function call ggstatsplot::ggbetweenstats( data = datasets::morley, x = Expt, y = Speed, type = "nonparametric", plot.type = "box", xlab = "The experiment number", ylab = "Speedoflight measurement", pairwise.comparisons = TRUE, p.adjust.method = "fdr", outlier.tagging = TRUE, outlier.label = Run, ggtheme = ggplot2::theme_grey(), ggstatsplot.layer = FALSE )# }