simplevis (version 2.4.0)

ggplot_vbar_facet: Vertical bar ggplot that is facetted.

Description

Vertical bar ggplot that is facetted, but not coloured.

Usage

ggplot_vbar_facet(data, x_var, y_var, facet_var, tip_var = NULL,
  x_labels = waiver(), x_pretty_n = 5, x_expand = NULL,
  y_zero = TRUE, y_zero_line = NULL, y_trans = "identity",
  y_labels = waiver(), y_pretty_n = 5, y_expand = NULL,
  y_balance = FALSE, y_na_bar = FALSE, facet_scales = "fixed",
  facet_nrow = NULL, pal = NULL, width = 0.75, title = "[Title]",
  subtitle = NULL, x_title = "[X title]", y_title = "[Y title]",
  caption = NULL, font_family = "Helvetica", font_size_title = NULL,
  font_size_body = NULL, title_wrap = 70, subtitle_wrap = 80,
  x_title_wrap = 50, y_title_wrap = 50, caption_wrap = 80)

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. Required input.

facet_var

Unquoted categorical variable to facet the data by. Required input.

tip_var

Unquoted variable to be used as a customised tooltip in combination with plotly::ggplotly(plot). Defaults to NULL.

x_labels

Argument to adjust the format of the x scale labels.

x_pretty_n

The desired number of intervals on the x axis, as calculated by the pretty algorithm. Defaults to 5.

x_expand

A vector of range expansion constants used to add some padding on the x scale.

y_zero

TRUE or FALSE of whether the minimum of the y scale is zero. Defaults to TRUE.

y_zero_line

TRUE or FALSE whether to add a zero reference line to the y axis. Defaults to NULL, which is TRUE if there are positive and negative values in y_var. Otherwise it is FALSE.

y_trans

A string specifying a transformation for the y axis scale, such as "log10" or "sqrt". Defaults to "identity".

y_labels

Argument to adjust the format of the y scale labels.

y_pretty_n

The desired number of intervals on the y axis, as calculated by the pretty algorithm. Defaults to 5.

y_expand

A vector of range expansion constants used to add some padding on the y scale.

y_balance

Add balance to the y axis so that zero is in the centre of the y scale. Only applicable where facet_scales equals "fixed" or "free_x".

y_na_bar

TRUE or FALSE of whether to make NA y_var values infinity with a light grey colour to emphasise them. Defaults to FALSE. Only functional where facet_scales = "fixed" or "free_x".

facet_scales

Whether facet_scales should be "fixed" across facets, "free" in both directions, or free in just one direction (i.e. "free_x" or "free_y"). Defaults to "fixed".

facet_nrow

The number of rows of facetted plots. Defaults to NULL, which generally chooses 2 rows. Not applicable to where isMobile is TRUE.

pal

Character vector of hex codes. Defaults to NULL, which selects a default palette.

width

Width of bars. Defaults to 0.75.

title

Title string. Defaults to [Title].

subtitle

Subtitle string. Defaults to [Subtitle].

x_title

X axis title string. Defaults to [X title].

y_title

Y axis title string. Defaults to [Y title].

caption

Caption title string. Defaults to NULL.

font_family

Font family to use. Defaults NULL.

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.

title_wrap

Number of characters to wrap the title to. Defaults to 70.

subtitle_wrap

Number of characters to wrap the subtitle to. Defaults to 80.

x_title_wrap

Number of characters to wrap the x title to. Defaults to 50.

y_title_wrap

Number of characters to wrap the y title to. Defaults to 50.

caption_wrap

Number of characters to wrap the caption to. Defaults to 80.

Value

A ggplot object.

Examples

# NOT RUN {
library(dplyr)

plot_data <- storms %>%
  mutate(status = stringr::str_to_sentence(status)) %>%
  group_by(year, status) %>%
  summarise(average_wind = round(mean(wind), 2)) 

ggplot_vbar_facet(plot_data, year, average_wind, status)

# }