ggstatsplot (version 0.0.3)

ggbetweenstats: violin plots for group or condition comparisons

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.

Usage

ggbetweenstats(data = NULL, x, y, plot.type = "boxviolin",
  type = "parametric", effsize.type = "unbiased", xlab = NULL,
  ylab = NULL, caption = NULL, title = NULL, k = 3, var.equal = FALSE,
  nboot = 100, notch = FALSE, notchwidth = 0.5, linetype = "solid",
  outlier.tagging = NULL, outlier.label = NULL,
  outlier.label.color = "black", outlier.color = "black",
  outlier.coef = 1.5, mean.plotting = TRUE, mean.size = 5,
  mean.color = "darkred", messages = TRUE)

Arguments

data

Dataframe from which variables specified are preferentially to be taken.

x

The grouping variable.

y

The response - a vector of length the number of rows of x.

plot.type

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

Type of statistic expected ("parametric" or "nonparametric" or "robust").Corresponding abbreviations are also accepted: "p" (for parametric), "np" (nonparametric), "r" (robust), resp.

effsize.type

Type of effect size needed for parametric tests ("biased" (Cohen's d for t-test; partial eta-squared for anova) or "unbiased" (Hedge's g for t-test; partial omega-squared for anova)).

xlab

Label for x axis variable.

ylab

Label for y axis variable.

caption

The text for the plot caption.

title

The text for the plot title.

k

Number of decimal places expected for results.

var.equal

A logical variable indicating whether to treat the two variances as being equal (Default: FALSE).

nboot

Number of bootstrap samples for computing effect size (Default: 100).

notch

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 interval for comparing medians. IQR: Inter-Quartile Range.

notchwidth

For a notched box plot, width of the notch relative to the body (default 0.5).

linetype

Character strings ("blank", "solid", "dashed", "dotted", "dotdash", "longdash", and "twodash") specifiying 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.).

outlier.tagging

Decides whether outliers should be tagged (Default: FALSE).

outlier.label

Label to put on the outliers that have been tagged.

outlier.label.color

Color for the label to to put on the outliers that have been tagged (Default: "black").

outlier.color

Default aesthetics for outliers (Default: "black").

outlier.coef

Coefficient for outlier detection using Tukey's method. With Tukey<U+2019>s method, outliers are below (1st Quartile) or above (3rd Quartile) outlier.coef times the Inter-Quartile Range (IQR) (Default: 1.5).

mean.plotting

Decides whether mean is to be highlighted and its value to be displayed (Default: TRUE).

mean.size

Point size for the data point corresponding to mean (Default: 5).

mean.color

Color for the data point corresponding to mean (Default: "darkred").

messages

Decides whether messages references, notes, and warnings are to be displayed (Default: TRUE).

See Also

grouped_ggbetweenstats

Examples

# NOT RUN {
# to get reproducible results from bootstrapping
set.seed(123)

# simple function call with the defaults
ggstatsplot::ggbetweenstats(
data = datasets::iris,
x = Species,
y = Sepal.Length
)

# more detailed function call
ggstatsplot::ggbetweenstats(
data = datasets::ToothGrowth,
x = supp,
y = len,
plot.type = "box",
xlab = "Supplement type",
ylab = "Tooth length")

# }