add_color_palette_y2: Add a 5 color palette

In nick-moffitt/y2artisan: Shortcuts for mschart and ggplot2

Add a 5 color palette

Description

Give a list of color names (e.g. blue) and the associated hex codes (e.g. #41536F). For each color given, add_color_palette_y2 will add a 5 color, monochromatic scale. Using position, choose where in the scale each hex code will start.

Usage

add_color_palette_y2(
  hex_codes = "#41536F",
  color_names = "Y2_BLUE",
  position = 3,
  colors_to_env = TRUE,
  show_colors = TRUE
)

Arguments

hex_codes	DEFAULT = '#41536F'; (Y2 blue) The hex code(s) of the color(s) for which you want to get a palette
color_names	DEFAULT = 'Y2_BLUE'; The color label you want associated with each hex code. String can be in any case
position	DEFAULT = 3; Position can be any of c(1, 2, 3, 4, 5). position = 1 will make the provided hex code the "DARKER" value while position = 5 will make it the "LIGHTER" value in the 5 point scale
colors_to_env	DEFAULT = TRUE; Whether you want your palettes saved to your R environment
show_colors	DEFAULT = TRUE; Whether you want a plot showing you the newly created color palettes for a quick reference

Examples

add_color_palette_y2()

add_color_palette_y2(
  hex_codes = c('#fd8420', '#558575', '#41536F'),
  color_names = c('Orange', 'gray', 'BLUE'),
  position = c(1, 3, 5),
  colors_to_env = TRUE,
  show_colors = TRUE
)

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