- data
An ungrouped summarised tibble or 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 numeric variable to be on the x scale for when stat = "boxplot" is selected.
- y_var
Unquoted categorical variable to be on the y scale (i.e. character, factor, or logical). Required input.
- 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 60.
- subtitle
Subtitle string.
- subtitle_wrap
Number of characters to wrap the subtitle to. Defaults to 60.
- x_zero_mid
For a numeric x variable, add balance to the x scale so that zero is in the centre of the x scale.
- x_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.
- 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. Use ggplot2::waiver() to keep x labels untransformed.
- 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 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_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. If NULL, categorical variable labels are converted to sentence case. Use ggplot2::waiver() to keep y labels untransformed.
- y_na_rm
TRUE or FALSE of whether to include y_var NA values. Defaults to FALSE.
- y_rev
For a categorical variable, TRUE or FALSE of whether the y variable variable is reversed. Defaults to FALSE.
- 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.
- caption
Caption title string.
- caption_wrap
Number of characters to wrap the caption to. Defaults to 75.
- theme
A ggplot2 theme.
- stat
String of "boxplot" or "identity". Defaults to "boxplot".
- xmin_var
Unquoted numeric variable for minimum of whisker on the x scale for when stat = "identity" is selected.
- xlower_var
Unquoted numeric variable for minimum of box on the x scale for when stat = "identity" is selected.
- xmiddle_var
Unquoted numeric variable for middle of box on the x scale for when stat = "identity" is selected.
- xupper_var
Unquoted numeric variable for maximum of box on the x scale for when stat = "identity" is selected.
- xmax_var
Unquoted numeric variable for maximum of whisker on the x scale for when stat = "identity" is selected.
- mobile
Whether the plot is to be displayed on a mobile device. Defaults to FALSE.