DEPRECATED. Horizontal bar ggplot that is not coloured and not facetted.
Usage
gg_hbar(
data,
x_var,
y_var,
text_var = NULL,
pal = pal_viridis_mix(1),
alpha_fill = 1,
alpha_line = 1,
size_line = 0.5,
width = NULL,
title = NULL,
title_wrap = 75,
subtitle = NULL,
subtitle_wrap = 75,
x_zero_mid = FALSE,
x_breaks_n = 5,
x_expand = c(0, 0),
x_labels = scales::label_comma(),
x_na_rm = FALSE,
x_title = NULL,
x_title_wrap = 50,
x_zero = TRUE,
x_zero_line = NULL,
y_zero_mid = FALSE,
y_breaks_n = 5,
y_expand = NULL,
y_labels = NULL,
y_na_rm = FALSE,
y_reorder = FALSE,
y_rev = FALSE,
y_title = NULL,
y_title_wrap = 50,
y_zero = FALSE,
y_zero_line = NULL,
caption = NULL,
caption_wrap = 75,
theme = gg_theme(x_grid = TRUE),
mobile = FALSE
)Arguments
- data
An ungrouped summarised tibble or data frame in a structure to be plotted untransformed. Required input.
- x_var
Unquoted numeric variable to be on the x scale. Required input.
- y_var
Unquoted variable to be on the y scale (i.e. character, factor, logical, numeric, date or datetime). If numeric, date or datetime, variable values are bins that are mutually exclusive and equidistant. Required input.
- text_var
Unquoted variable to be used as a customised tooltip in combination with plotly::ggplotly(plot, tooltip = "text"). Defaults to NULL.
- pal
Character vector of hex codes.
- alpha_fill
The opacity of the fill. Defaults to 1.
- alpha_line
The opacity of the outline. Defaults to 1.
- size_line
The size of the outlines of bars.
- width
Width of bars. Defaults to 0.75.
- 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 function(x) x to keep labels untransformed.
- x_na_rm
TRUE or FALSE of whether to include x_var NA values. 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 TRUE.
- 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_zero_mid
For a numeric y variable, add balance to the y scale so that zero is in the centre. Defaults to FALSE.
- y_breaks_n
For a numeric or date y variable, the desired number of intervals on the y 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. If NULL, categorical variable labels are converted to sentence case. Use function(x) x to keep labels untransformed.
- y_na_rm
TRUE or FALSE of whether to include y_var NA values. Defaults to FALSE.
- y_reorder
For a categorical y variable, TRUE or FALSE of whether the y variable variable is to be reordered by the y variable. 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.
- y_zero
For a numeric y variable, TRUE or FALSE of whether the minimum of the y scale is zero. Defaults to FALSE.
- y_zero_line
For a numeric y variable, TRUE or FALSE of 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 75.
- theme
A ggplot2 theme.
- mobile
Whether the plot is to be displayed on a mobile device. Defaults to FALSE.
