DEPRECATED. Boxplot ggplot that is not coloured and not facetted.
Usage
gg_boxplot(
data,
x_var,
y_var = NULL,
pal = pal_viridis_mix(1),
alpha_fill = 0.5,
alpha_line = 1,
alpha_point = 1,
size_line = 0.5,
size_point = 1.5,
width = 0.5,
title = NULL,
title_wrap = 80,
subtitle = NULL,
subtitle_wrap = 80,
x_expand = ggplot2::waiver(),
x_labels = snakecase::to_sentence_case,
x_na_rm = FALSE,
x_rev = FALSE,
x_title = NULL,
x_title_wrap = 50,
y_zero_mid = FALSE,
y_breaks_n = 5,
y_expand = c(0, 0),
y_labels = scales::label_comma(),
y_title = NULL,
y_title_wrap = 50,
y_zero = FALSE,
y_zero_line = NULL,
caption = NULL,
caption_wrap = 80,
stat = "boxplot",
ymin_var = NULL,
ylower_var = NULL,
ymiddle_var = NULL,
yupper_var = NULL,
ymax_var = NULL,
theme = gg_theme(y_grid = TRUE),
mobile = FALSE
)Arguments
- data
A data frame generally in a structure to be transformed to boxplot statistics (or alternatively in a structure of summary boxplot statistics). Required input.
- x_var
Unquoted categorical variable to be on the x scale (i.e. character, factor, logical). Required input.
- y_var
Unquoted numeric variable to be on the y scale for when stat = "boxplot" is selected.
- pal
Character vector of hex codes.
- alpha_fill
The opacity of the fill. Defaults to 0.5.
- alpha_line
The opacity of the outline. Defaults to 1.
- alpha_point
The opacity of the outlier points. Defaults to 1.
- size_line
The size of the outlines of boxplots. Defaults to 0.5.
- size_point
The size of the outlier points. Defaults to 1.5.
- width
Width of boxes. Defaults to 0.5.
- title
Title string.
- title_wrap
Number of characters to wrap the title to. Defaults to 75.
- subtitle
Subtitle string.
- subtitle_wrap
Number of characters to wrap the subtitle to. Defaults to 75.
- x_expand
A vector of range expansion constants used to add padding to the x scale, as per the ggplot2 expand argument in ggplot2 scales functions.
- x_labels
A function or named vector to modify x scale labels. If NULL, categorical variable labels are converted to sentence case. Use ggplot2::waiver() to keep x labels untransformed.
- x_na_rm
TRUE or FALSE of whether to include x_var NA values. Defaults to FALSE.
- x_rev
For a categorical x variable, TRUE or FALSE of whether the x variable variable is reversed. Defaults to FALSE.
- x_title
x scale title string. Defaults to NULL, which converts to sentence case with spaces. Use "" if you would like no title.
- x_title_wrap
Number of characters to wrap the x title to. Defaults to 50.
- y_zero_mid
For a numeric y variable, add balance to the y scale so that zero is in the centre of the y scale.
- y_breaks_n
For a numeric or date x variable, the desired number of intervals on the x scale, as calculated by the pretty algorithm. Defaults to 5.
- y_expand
A vector of range expansion constants used to add padding to the y scale, as per the ggplot2 expand argument in ggplot2 scales functions.
- y_labels
A function or named vector to modify y scale labels. Use ggplot2::waiver() to keep y labels untransformed.
- y_title
y scale title string. Defaults to NULL, which converts to sentence case with spaces. Use "" if you would like no title.
- y_title_wrap
Number of characters to wrap the y title to. Defaults to 50.
- y_zero
For a numeric y variable, TRUE or FALSE of whether the minimum of the y scale is zero. Defaults to TRUE.
- y_zero_line
For a numeric y variable, TRUE or FALSE whether to add a zero reference line to the y scale. Defaults to TRUE if there are positive and negative values in y_var. Otherwise defaults to FALSE.
- caption
Caption title string.
- caption_wrap
Number of characters to wrap the caption to. Defaults to 80.
- stat
String of "boxplot" or "identity". Defaults to "boxplot".
- ymin_var
Unquoted numeric variable for minimum of whisker on the y scale for when stat = "identity" is selected.
- ylower_var
Unquoted numeric variable for minimum of box on the y scale for when stat = "identity" is selected.
- ymiddle_var
Unquoted numeric variable for middle of box on the y scale for when stat = "identity" is selected.
- yupper_var
Unquoted numeric variable for maximum of box on the y scale for when stat = "identity" is selected.
- ymax_var
Unquoted numeric variable for maximum of whisker on the y scale for when stat = "identity" is selected.
- theme
A ggplot2 theme.
- mobile
Whether the plot is to be displayed on a mobile device. Defaults to FALSE.
Examples
library(dplyr)
library(simplevis)
library(palmerpenguins)
gg_boxplot(penguins,
x_var = species,
y_var = body_mass_g)
#> Warning: Removed 2 rows containing non-finite values (stat_boxplot).
plot_data <- penguins %>%
group_by(species) %>%
summarise_boxplot_stats(body_mass_g)
outliers <- penguins %>%
group_by(species) %>%
summarise_boxplot_outliers(body_mass_g)
gg_boxplot(plot_data,
x_var = species,
ymin_var = min,
ylower_var = lower,
ymiddle_var = middle,
yupper_var = upper,
ymax_var = max,
stat = "identity",
y_title = "Body mass g",
y_breaks_n = 4) +
ggplot2::geom_point(ggplot2::aes(x = species, y = body_mass_g),
size = 0.75, col = pal_viridis_mix(1),
data = outliers)
