ggbetweenstats_wrapper: Wrapper for (grouped_)ggbetweenstats in 'ggstatsplot'

In liuyujie0136/tinyfuncr: tiny R functions

Wrapper for ⁠(grouped_)ggbetweenstats⁠ in ggstatsplot

Description

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.

• Remove outliers from violin plot for clarity, while using all of the data for pairwise test and boxplot.

• Remove useless parameters for outliers.

Usage

ggbetweenstats_wrapper(
  data,
  x,
  y,
  facet = TRUE,
  grouping.var = NULL,
  plotgrid.args = list(),
  annotation.args = list(),
  ...
)

Arguments

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 data.
y	The response (or outcome or dependent) variable from the dataframe data.
facet	whether to use grouping.var, default TRUE.
grouping.var	A single grouping variable (can be entered either as a bare name x or as a string "x").
plotgrid.args	A list of additional arguments passed to patchwork::wrap_plots, except for guides argument which is already separately specified here.
annotation.args	A list of additional arguments passed to patchwork::plot_annotation.
plot.type	Character describing the type of plot. Currently supported plots are "box" (for only boxplots), "violin" (for only violin plots), and "boxviolin" (for a combination of box and violin plots; default).
xlab, ylab	Labels for x and y axis variables. If NULL (default), variable names for x and y will be used.
pairwise.comparisons	Logical that decides whether pairwise comparisons are to be displayed (default: TRUE). Please note that only significant comparisons will be shown by default. To change this behavior, select appropriate option with pairwise.display argument. The pairwise comparison dataframes are prepared using the ggstatsplot::pairwise_comparisons function. For more details about pairwise comparisons, see the documentation for that function.
p.adjust.method	Adjustment method for p-values for multiple comparisons. Possible methods are: "holm" (default), "hochberg", "hommel", "bonferroni", "BH", "BY", "fdr", "none".
pairwise.display	Decides which pairwise comparisons to display. Available options are: "significant" (abbreviation accepted: "s") "non-significant" (abbreviation accepted: "ns") "all" You can use this argument to make sure that your plot is not uber-cluttered when you have multiple groups being compared and scores of pairwise comparisons being displayed.
bf.prior	A number between 0.5 and 2 (default 0.707), the prior width to use in calculating Bayes factors.
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: TRUE).
results.subtitle	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	The text for the plot title.
subtitle	The text for the plot subtitle. Will work only if results.subtitle = FALSE.
caption	The text for the plot caption.
outlier.coef	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).
centrality.plotting	Logical that decides whether centrality tendency measure is to be displayed as a point with a label (Default: TRUE). Function decides which central tendency measure to show depending on the type argument. mean for parametric statistics median for non-parametric statistics trimmed mean for robust statistics MAP estimator for Bayesian statistics If you want default centrality parameter, you can specify this using centrality.type argument.
centrality.type	Decides which centrality parameter is to be displayed. The default is to choose the same as type argument. You can specify this to be: "parameteric" (for mean) "nonparametric" (for median) robust (for trimmed mean) bayes (for MAP estimator) Just as type argument, abbreviations are also accepted.
point.args	A list of additional aesthetic arguments to be passed to the geom_point displaying the raw data.
violin.args	A list of additional aesthetic arguments to be passed to the geom_violin.
ggplot.component	A ggplot component to be added to the plot prepared by ggstatsplot. This argument is primarily helpful for grouped_ variants of all primary functions. Default is NULL. The argument should be entered as a ggplot2 function or a list of ggplot2 functions.
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 View(paletteer::palettes_d_names).
centrality.point.args, centrality.label.args	A list of additional aesthetic arguments to be passed to ggplot2::geom_point and ggrepel::geom_label_repel geoms, which are involved in mean plotting.
ggsignif.args	A list of additional aesthetic arguments to be passed to ggsignif::geom_signif.

Author(s)

• Originally by Indrajeet Patil

• Wrapped by Yujie Liu

References

https://indrajeetpatil.github.io/ggstatsplot/articles/web_only/ggbetweenstats.html

See Also

ggstatsplot::ggbetweenstats() and ggstatsplot::grouped_ggbetweenstats()

liuyujie0136/tinyfuncr documentation built on Dec. 13, 2024, 8:49 a.m.