Boxplot ggplot.

Boxplot ggplot that is not coloured and not facetted.

ggplot_boxplot(
  data,
  x_var,
  y_var = NULL,
  stat = "boxplot",
  pal = NULL,
  width = 0.5,
  alpha = 1,
  size_line = 0.5,
  size_point = 1,
  title = NULL,
  title_wrap = 70,
  subtitle = NULL,
  subtitle_wrap = 80,
  x_balance = FALSE,
  x_labels = waiver(),
  x_pretty_n = 6,
  x_expand = NULL,
  x_rev = FALSE,
  x_title = NULL,
  x_title_wrap = 50,
  x_zero = FALSE,
  x_zero_line = NULL,
  y_balance = FALSE,
  y_expand = NULL,
  y_labels = waiver(),
  y_pretty_n = 5,
  y_title = NULL,
  y_title_wrap = 50,
  y_trans = "identity",
  y_zero = FALSE,
  y_zero_line = NULL,
  caption = NULL,
  caption_wrap = 80,
  font_family = "Helvetica",
  font_size_title = NULL,
  font_size_body = NULL,
  mobile = FALSE
)

Arguments

data	A tibble or dataframe. Required input.
x_var	Unquoted numeric, date or categorical variable to be on the x axis. Required input.
y_var	Unquoted numeric variable to be on the y axis. Defaults to NULL. Required if stat equals "boxplot".
stat	String of "boxplot" or "identity". Defaults to "boxplot". If identity is selected, data provided must be grouped by the x_var with ymin, lower, middle, upper, ymax variables. Note "identity" does not provide outliers.
pal	Character vector of hex codes. Defaults to viridis. Use the pals package to find a suitable palette.
width	Width of the box. Defaults to 0.5.
alpha	The alpha of the fill. Defaults to 1.
size_line	The size of the outlines of boxplots. Defaults to 0.5.
size_point	The size of the outliers. Defaults to 1.
title	Title string. Defaults to NULL.
title_wrap	Number of characters to wrap the title to. Defaults to 70. Not applicable where mobile equals TRUE.
subtitle	Subtitle string. Defaults to "[Subtitle]".
subtitle_wrap	Number of characters to wrap the subtitle to. Defaults to 80. Not applicable where mobile equals TRUE.
x_balance	For a numeric x variable, add balance to the x scale so that zero is in the centre. Defaults to FALSE.
x_labels	Adjust the x scale labels through a function that takes the breaks as input and returns labels as output.
x_pretty_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 6.
x_expand	Adjust the vector of range expansion constants used to add some padding on the x scale.
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.
x_zero	For a numeric x variable, TRUE or FALSE of whether the minimum of the x scale is zero. Defaults to FALSE.
x_zero_line	For a numeric x variable, TRUE or FALSE of whether to add a zero reference line to the x scale. Defaults to TRUE if there are positive and negative values in x_var. Otherwise defaults to FALSE.
y_balance	For a numeric y variable, add balance to the y scale so that zero is in the centre of the y scale.
y_expand	Adjust the vector of range expansion constants used to add some padding on the y scale.
y_labels	Adjust the y scale labels through a function that takes the breaks as input and returns labels as output.
y_pretty_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_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_trans	For a numeric y variable, a string specifying a transformation for the y scale, such as "log10" or "sqrt". Defaults to "identity".
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. Defaults to NULL.
caption_wrap	Number of characters to wrap the caption to. Defaults to 80. Not applicable where mobile equals TRUE.
font_family	Font family to use. Defaults to "Helvetica".
font_size_title	Font size for the title text. Defaults to 11.
font_size_body	Font size for all text other than the title. Defaults to 10.
mobile	Whether the plot is to be displayed on a mobile device. Defaults to FALSE. If within an app with the mobileDetect function, then use mobile = input$isMobile.

Value

A ggplot object.

Examples

library(dplyr)
#> 
#> Attaching package: ‘dplyr’
#> The following objects are masked from ‘package:stats’:
#> 
#>     filter, lag
#> The following objects are masked from ‘package:base’:
#> 
#>     intersect, setdiff, setequal, union

plot_data <- iris %>%
tibble::as_tibble() %>%
  mutate(Species = stringr::str_to_sentence(Species))

ggplot_boxplot(plot_data, Species, Petal.Length,
  title = "Iris petal length by species",
  x_title = "Species",
  y_title = "Petal length (cm)")

plot_data <- iris %>%
  group_by(Species) %>%
  summarise(boxplot_stats = list(rlang::set_names(boxplot.stats(Petal.Length)$stats,
                                                 c('ymin','lower','middle','upper','ymax')))) %>%
 tidyr::unnest_wider(boxplot_stats)

ggplot_boxplot(plot_data, Species, Petal.Length, stat = "identity")