Learn R Programming

simplevis (version 4.4.0)

gg_density_col: Smoothed density ggplot that is coloured.

Description

Smoothed density ggplot that is coloured but not facetted.

Usage

gg_density_col(data, x_var, col_var, density_bw = "nrd0",
  density_adjust = 1, density_kernel = "gaussian", density_n = 512,
  density_trim = FALSE, pal = NULL, pal_rev = FALSE, alpha = 0.1,
  size_line = 0.5, title = NULL, title_wrap = 100, subtitle = NULL,
  subtitle_wrap = 100, x_balance = FALSE, x_expand = NULL,
  x_labels = NULL, x_pretty_n = 6, x_title = NULL,
  x_title_wrap = 50, x_zero = FALSE, x_zero_line = NULL,
  y_expand = NULL, y_gridlines_minor = FALSE,
  y_labels = scales::number, y_pretty_n = 5, y_title = NULL,
  y_title_wrap = 50, col_labels = NULL, col_legend_ncol = NULL,
  col_legend_nrow = NULL, col_na = TRUE, col_rev = FALSE,
  col_title = NULL, col_title_wrap = 25, caption = NULL,
  caption_wrap = 80, font_family = "", font_size_title = NULL,
  font_size_body = NULL, mobile = FALSE)

Arguments

data

A tibble or dataframe. Required input.

x_var

Unquoted numeric variable to be on the x scale. Required input.

col_var

Unquoted categorical variable to colour density areas. Required input.

density_bw

The bw argument of the stats::density function. Defaults to "nrd0".

density_adjust

The adjust argument of the stats::density function. Defaults to 1.

density_kernel

The kernel argument of the stats::density function. Defaults to "gaussian".

density_n

The n argument of the stats::density function. Defaults to 512.

density_trim

The trim argument of the stats::density function. Defaults to FALSE.

pal

Character vector of hex codes.

pal_rev

Reverses the palette. Defaults to FALSE.

alpha

The alpha of the fill. Defaults to 0.1.

size_line

The size of the outlines of density areas.

title

Title string. Defaults to NULL.

title_wrap

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

subtitle

Subtitle string.

subtitle_wrap

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

x_balance

For a numeric x variable, add balance to the x scale so that zero is in the centre. Defaults to FALSE.

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 vector to modify x scale labels, as per the ggplot2 labels argument in ggplot2 scales functions. If NULL, categorical variable labels are converted to sentence case. Use ggplot2::waiver() to keep x labels untransformed.

x_pretty_n

For a numeric x variable, the desired number of intervals on the x scale, as calculated by the pretty algorithm. Defaults to 6.

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 of 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_gridlines_minor

TRUE or FALSE of whether to add minor gridlines to the y scale. Defaults to FALSE.

y_labels

A function or vector to modify y scale labels, as per the ggplot2 labels argument in ggplot2 scales functions. If NULL, categorical variable labels are converted to sentence case. Use ggplot2::waiver() to keep y labels untransformed.

y_pretty_n

For a numeric y variable, the desired number of intervals on the y scale, as calculated by the pretty algorithm. Defaults to 5.

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.

col_labels

A function or vector to modify colour scale labels, as per the ggplot2 labels argument in ggplot2 scales functions. If NULL, categorical variable labels are converted to sentence case. Use ggplot2::waiver() to keep y labels untransformed.

col_legend_ncol

The number of columns in the legend.

col_legend_nrow

The number of rows in the legend.

col_na

TRUE or FALSE of whether to include col_var NA values. 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, which converts to sentence case with spaces. Use "" if you would like no title.

col_title_wrap

Number of characters to wrap the colour title to. Defaults to 25.

caption

Caption title string.

caption_wrap

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

font_family

Font family to use. Defaults to "".

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 a shiny app with the mobileDetect function, then use mobile = input$isMobile.

Value

A ggplot object.

Examples

Run this code
# NOT RUN {
library(simplevis)
library(palmerpenguins)

gg_density_col(penguins, 
               x_var = body_mass_g, 
               col_var = species)

# }

Run the code above in your browser using DataLab