Horizontal pointrange ggplot that is coloured, but not facetted.
gg_hpointrange_col(
data,
xmiddle_var,
xmin_var,
xmax_var,
y_var,
col_var,
text_var = NULL,
pal = NULL,
pal_na = "#7F7F7F",
pal_rev = FALSE,
alpha_line = 1,
alpha_point = 1,
size_point = 1.5,
size_line = 0.5,
title = NULL,
title_wrap = 75,
subtitle = NULL,
subtitle_wrap = 75,
x_balance = FALSE,
x_breaks_n = 5,
x_expand = c(0, 0),
x_labels = scales::label_comma(),
x_na_rm = FALSE,
x_title = "",
x_title_wrap = 50,
x_zero = FALSE,
x_zero_line = NULL,
y_balance = FALSE,
y_breaks_n = 5,
y_dodge = 0,
y_expand = NULL,
y_labels = NULL,
y_na_rm = FALSE,
y_rev = FALSE,
y_title = NULL,
y_title_wrap = 50,
y_zero = FALSE,
y_zero_line = NULL,
col_breaks_n = 4,
col_cuts = NULL,
col_intervals_right = TRUE,
col_labels = NULL,
col_legend_none = FALSE,
col_method = NULL,
col_na_rm = FALSE,
col_rev = FALSE,
col_title = NULL,
col_title_wrap = 25,
caption = NULL,
caption_wrap = 75,
theme = gg_theme(gridlines_v = TRUE),
mobile = FALSE
)An ungrouped summarised tibble or dataframe in a structure to be plotted untransformed. Required input.
Unquoted numeric variable to be on the x scale. Required input.
Unquoted numeric variable to be the minimum of the x vertical line. Required input.
Unquoted numeric variable to be the maximum of the x vertical line. Required input.
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.
Unquoted categorical or numeric variable to colour the pointranges. Required input.
Unquoted variable to be used as a customised tooltip in combination with plotly::ggplotly(plot, tooltip = "text"). Defaults to NULL.
Character vector of hex codes.
The hex code or name of the NA colour to be used.
Reverses the palette. Defaults to FALSE.
The opacity of the line. Defaults to 1.
The opacity of the points.
Size of points. Defaults to 1.5.
Size of lines. Defaults to 0.75.
Title string.
Number of characters to wrap the title to. Defaults to 60.
Subtitle string.
Number of characters to wrap the subtitle to. Defaults to 60.
For a numeric x variable, add balance to the x scale so that zero is in the centre of the x scale.
For a numeric or date x variable, the desired number of intervals on the x scale, as calculated by the pretty algorithm. Defaults to 2.
A vector of range expansion constants used to add padding to the x scale, as per the ggplot2 expand argument in ggplot2 scales functions.
A function or named vector to modify x scale labels. Use function(x) x to keep labels untransformed.
TRUE or FALSE of whether to include xmiddle_var NA values. Defaults to FALSE.
X scale title string. Defaults to "".
Number of characters to wrap the x title to. Defaults to 50.
For a numeric x variable, TRUE or FALSE of whether the minimum of the x scale is zero. Defaults to FALSE.
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 xmiddle_var. Otherwise defaults to FALSE.
For a numeric y variable, add balance to the y scale so that zero is in the centre. Defaults to FALSE.
For a numeric or date y variable, the desired number of intervals on the y scale, as calculated by the pretty algorithm. Defaults to 4.
The amount to dodge pointranges by along the y axis. Defaults to 0 (i.e. identity).
A vector of range expansion constants used to add padding to the y scale, as per the ggplot2 expand argument in ggplot2 scales functions.
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.
TRUE or FALSE of whether to include y_var NA values. Defaults to FALSE.
For a categorical variable, TRUE or FALSE of whether the y variable variable is reversed. Defaults to FALSE.
y scale title string. Defaults to NULL, which converts to sentence case with spaces. Use "" if you would like no title.
Number of characters to wrap the y title to. Defaults to 50.
For a numeric y variable, TRUE or FALSE of whether the minimum of the y scale is zero. Defaults to FALSE.
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.
For a numeric colour variable, the desired number of intervals on the colour scale.
A vector of cuts to colour a numeric variable. If "bin" is selected, the first number in the vector should be either -Inf or 0, and the final number Inf. If "quantile" is selected, the first number in the vector should be 0 and the final number should be 1. Defaults to quartiles.
For a numeric colour variable, TRUE or FALSE of whether bins or quantiles are to be cut right-closed. Defaults to TRUE.
A function or named vector to modify colour scale labels. Defaults to snakecase::to_sentence_case for categorical colour variables and scales::label_comma() for numeric. Use function(x) x to keep labels untransformed.
TRUE or FALSE of whether to remove the legend.
The method of colouring features, either "bin", "quantile", "continuous", or "category." If numeric, defaults to "bin".
TRUE or FALSE of whether to include col_var NA values. Defaults to FALSE.
TRUE or FALSE of whether the colour scale is reversed. Defaults to FALSE.
Colour title string for the legend. Defaults to NULL, which converts to sentence case with spaces. Use "" if you would like no title.
Number of characters to wrap the colour title to. Defaults to 25. Not applicable where mobile equals TRUE.
Caption title string.
Number of characters to wrap the caption to. Defaults to 75.
A ggplot2 theme.
Whether the plot is to be displayed on a mobile device. Defaults to FALSE.
A ggplot object.
# NOT RUN {
library(dplyr)
library(simplevis)
library(palmerpenguins)
plot_data <- penguins %>%
group_by(sex, species) %>%
summarise(middle = median(body_mass_g, na.rm = TRUE),
lower = quantile(body_mass_g, probs = 0.25, na.rm = TRUE),
upper = quantile(body_mass_g, probs = 0.75, na.rm = TRUE))
gg_hpointrange_col(
plot_data,
xmiddle_var = middle,
xmin_var = lower,
xmax_var = upper,
y_var = species,
col_var = sex,
col_na_rm = TRUE,
x_title = "Body mass g",
y_dodge = 0.2)
# }
Run the code above in your browser using DataLab