gg_histo_y2: Create a ggplot2 histogram

View source: R/gg_histo_y2.R

gg_histo_y2R Documentation

Create a ggplot2 histogram

Description

This function creates a ggplot2 histogram object of a given variable with a dotted vertical line at the mean

Usage

gg_histo_y2(
  data,
  x_var,
  fills = "#474E7E",
  axis_text_size = 16,
  axis_title_size = 18,
  bins = NULL,
  binwidth = NULL,
  color_mean_line = "#474747",
  font_family = "Flama",
  mean_line = c("mean", "median", "none"),
  quadrant_lines = FALSE,
  weight_var = NULL,
  x_limits = "no limits",
  x_label = "",
  y_label = "Respondents"
)

Arguments

data

NO DEFAULT; a data frame containing the variable you want to histogram

x_var

NO DEFAULT; the variable name for which you want to create a histogram

fills

NO DEFAULT; the fill color for the histogram

axis_text_size

DEFAULT = 16; Font size for scale points along the axis

axis_title_size

DEFAULT = 18; Font size for x_label and y_label

bins

DEFAULT = 30; The number of bins. Same as the ggplot2 function, geom_histogram

binwidth

DEFAULT = NULL; The number of units in the x_var that fit in a bin. Overrides the bins argument

color_mean_line

DEFAULT = '#474747', a gray/black color

font_family

DEFAULT = 'Flama'; all fonts used need to be previously loaded in using the font_add() and showtext_auto() functions

mean_line

DEFAULT = "mean", must be one of c("mean", "median", "none")

quadrant_lines

DEFAULT = FALSE. Set to TRUE to display dotted lines on the 25th and 75th percentiles

weight_var

DEFAULT = NULL; set to your weights variable if working with weighted data

x_limits

DEFAULT = 'no limits'; The 'no limits' default allows the histogram to capture all values for the variable. A secondary option is '95 trim' which will set the limits of the histogram to within 2 standard deviations of the mean, or all values between the 5th and 95th percentiles. Alternatively, you can set your own limits using c(my_min, my_max)

x_label

DEFAULT = ”; Title for the x_axis

y_label

DEFAULT = 'Respondents'; Title for the x_axis (the y axis is set to show the number of respondents in a given bin)

Examples

chart <- iris %>% gg_histo_y2(
  Petal.Width,
  'purple',
  binwidth = .25,
  font_family = 'sans'
)

nick-moffitt/y2artisan documentation built on Aug. 22, 2024, 4:30 a.m.