Learn R Programming

simplevis (version 3.1.0)

ggplot_boxplot_col: ggplot boxplot that is coloured

Description

ggplot boxplot that is coloured

Usage

ggplot_boxplot_col(data, x_var, y_var = NULL, col_var,
  group_var = NULL, stat = "boxplot", pal = NULL, pal_rev = FALSE,
  width = 0.5, alpha = 1, size_line = 0.5, size_point = 1,
  title = "[Title]", title_wrap = 70, subtitle = NULL,
  subtitle_wrap = 80, x_expand = NULL, x_labels = waiver(),
  x_title = "[X title]", x_title_wrap = 50, y_balance = FALSE,
  y_expand = NULL, y_labels = waiver(), y_pretty_n = 5,
  y_title = "[Y title]", y_title_wrap = 50, y_trans = "identity",
  y_zero = FALSE, y_zero_line = NULL, col_labels = NULL,
  col_legend_ncol = NULL, col_legend_nrow = NULL, col_na = TRUE,
  col_rev = FALSE, col_title = "", col_title_wrap = 25,
  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 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".

col_var

Unquoted categorical variable to colour the fill of the boxes. Required input.

group_var

Unquoted variable to be the grouping variable Defaults to NULL. Only applicable 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.

pal_rev

Reverses the palette. Defaults to FALSE.

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 "[Title]".

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_expand

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

x_labels

Adjust the x scale labels through a function or vector.

x_title

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

x_title_wrap

Number of characters to wrap the x title to. Defaults to 50. Not applicable where mobile equals TRUE.

y_balance

Add balance to the y axis so that zero is in the centre of the y scale.

y_expand

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

y_labels

Adjust the y scale labels through a function or vector.

y_pretty_n

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

y_title

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

y_title_wrap

Number of characters to wrap the y title to. Defaults to 50. Not applicable where mobile equals TRUE.

y_trans

TRUEransformation of y-axis scale (e.g. "signed_sqrt"). Defaults to "identity", which has no transformation.

y_zero

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

y_zero_line

TRUE or FALSE whether to add a zero reference line to the y axis. TRUE if there are positive and negative values in y_var. Otherwise defaults to FALSE.

col_labels

Adjust the colour scale labels through a vector.

col_legend_ncol

The number of columns in the legend. Defaults to 1.

col_legend_nrow

The number of rows in the legend.

col_na

TRUE or FALSE of whether to show NA values of the colour variable. Defaults to TRUE.

col_rev

TRUE or FALSE of whether the colour scale is reversed. Defaults to FALSE. Defaults to FALSE.

col_title

Colour title string for the legend. Defaults to NULL.

col_title_wrap

Number of characters to wrap the colour title to. Defaults to 25. Not applicable where mobile equals TRUE.

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

Run this code
# NOT RUN {
library(dplyr)

plot_data <- ggplot2::diamonds %>%
  mutate(cut = stringr::str_to_sentence(cut)) 

plot <- ggplot_boxplot_col(plot_data, cut, price, clarity, 
                           title = "Average diamond price by cut and clarity", 
                           x_title = "Average price ($US thousands)", 
                           y_title = "Cut") 

plot

plotly::ggplotly(plot) %>% 
  plotly::layout(boxmode = "group") %>% 
  plotly_camera()
# }

Run the code above in your browser using DataLab