272 lines
9.8 KiB
R
272 lines
9.8 KiB
R
#' @title ggplot2 theme with REACH color palettes
|
|
#'
|
|
#' @param initiative Either "reach" or "default".
|
|
#' @param palette Palette name from 'pal_reach()'.
|
|
#' @param discrete Boolean indicating whether color aesthetic is discrete or not.
|
|
#' @param reverse Boolean indicating whether the palette should be reversed.
|
|
#' @param font_family The font family for all plot's texts. Default to "Leelawadee".
|
|
#' @param title_size The size of the title. Defaults to 12.
|
|
#' @param title_color Title color.
|
|
#' @param title_font_face Title font face. Default to "bold". Font face ("plain", "italic", "bold", "bold.italic").
|
|
#' @param text_size The size of all text other than the title, subtitle and caption. Defaults to 10.
|
|
#' @param text_color Text color.
|
|
#' @param text_font_face Text font face. Default to "bold". Font face ("plain", "italic", "bold", "bold.italic").
|
|
#' @param panel_background_color The color for the panel background color. Default to white.
|
|
#' @param legend_position Position of the legend; Default to "right". Can take "right", "left", "top", "bottom" or "none".
|
|
#' @param legend_direction Direction of the legend. Default to "vertical". Can take "vertical" or "horizontal".
|
|
#' @param legend_title_size Legend title size.
|
|
#' @param legend_title_color Legend title color.
|
|
#' @param legend_title_font_face Legend title font face. Default to "plain". Font face ("plain", "italic", "bold", "bold.italic").
|
|
#' @param legend_text_size Legend text size.
|
|
#' @param legend_text_color Legend text color.
|
|
#' @param legend_text_font_face Legend text font face. Default to "plain". Font face ("plain", "italic", "bold", "bold.italic").
|
|
#' @param legend_reverse Reverse the color in the guide? Default to TRUE.
|
|
#' @param title_size The size of the legend title. Defaults to 11.
|
|
#' @param title_color Legend title color.
|
|
#' @param title_font_face Legend title font face. Default to "plain". Font face ("plain", "italic", "bold", "bold.italic").
|
|
#' @param title_position_to_plot TRUE or FALSE. Positioning to plot or to panel?
|
|
#' @param axis_x Boolean. Do you need x-axis?
|
|
#' @param axis_y Boolean. Do you need y-axis?
|
|
#' @param axis_text_size Axis text size.
|
|
#' @param axis_text_color Axis text color.
|
|
#' @param axis_text_font_face Axis text font face. Default to "plain". Font face ("plain", "italic", "bold", "bold.italic").
|
|
#' @param axis_text_x_angle Angle for the x-axis text.
|
|
#' @param axis_text_x_vjust Vertical adjustment for the x-axis text.
|
|
#' @param axis_text_x_hjust Vertical adjustment for the x-axis text.
|
|
#' @param axis_title_size Axis title size.
|
|
#' @param axis_title_color Axis title color.
|
|
#' @param axis_title_font_face Axis title font face. Default to "plain". Font face ("plain", "italic", "bold", "bold.italic").
|
|
#' @param grid_major_x Boolean. Do you need major grid lines for x-axis?
|
|
#' @param grid_major_y Boolean. Do you need major grid lines for y-axis?
|
|
#' @param grid_major_x_size Major X line size.
|
|
#' @param grid_major_y_size Major Y line size.
|
|
#' @param grid_major_color Major grid lines color.
|
|
#' @param grid_minor_x Boolean. Do you need minor grid lines for x-axis?
|
|
#' @param grid_minor_y Boolean. Do you need minor grid lines for y-axis?
|
|
#' @param grid_minor_x_size Minor X line size.
|
|
#' @param grid_minor_y_size Minor Y line size.
|
|
#' @param grid_minor_color Minor grid lines color.
|
|
#' @param caption_position_to_plot TRUE or FALSE. Positioning to plot or to panel?
|
|
#' @param ... Additional arguments passed to `ggplot2::gg_theme()`.
|
|
#'
|
|
#'
|
|
#' @description Give some reach colors and fonts to a ggplot.
|
|
#'
|
|
#' @return The base REACH theme
|
|
#'
|
|
#' @export
|
|
theme_reach <- function(
|
|
initiative = "reach",
|
|
palette = "main",
|
|
discrete = TRUE,
|
|
reverse = FALSE,
|
|
font_family = "Segoe UI",
|
|
title_size = 12,
|
|
title_color = cols_reach("main_grey"),
|
|
title_font_face = "bold",
|
|
title_position_to_plot = TRUE,
|
|
text_size = 10,
|
|
text_color = cols_reach("main_grey"),
|
|
text_font_face = "plain",
|
|
panel_background_color = "#FFFFFF",
|
|
legend_position = "right",
|
|
legend_direction = "vertical",
|
|
legend_reverse = TRUE,
|
|
legend_title_size = 11,
|
|
legend_title_color = cols_reach("main_grey"),
|
|
legend_title_font_face = "plain",
|
|
legend_text_size = 10,
|
|
legend_text_color = cols_reach("main_grey"),
|
|
legend_text_font_face = "plain",
|
|
axis_x = TRUE,
|
|
axis_y = TRUE,
|
|
axis_text_size = 10,
|
|
axis_text_color = cols_reach("main_grey"),
|
|
axis_text_font_face = "plain",
|
|
axis_title_size = 11,
|
|
axis_title_color = cols_reach("main_grey"),
|
|
axis_title_font_face = "bold",
|
|
axis_text_x_angle = 0,
|
|
axis_text_x_vjust = 0.5,
|
|
axis_text_x_hjust = 0.5,
|
|
grid_major_x = FALSE,
|
|
grid_major_y = FALSE,
|
|
grid_major_color = cols_reach("main_lt_grey"),
|
|
grid_major_x_size = 0.1,
|
|
grid_major_y_size = 0.1,
|
|
grid_minor_x = FALSE,
|
|
grid_minor_y = FALSE,
|
|
grid_minor_color = cols_reach("main_lt_grey"),
|
|
grid_minor_x_size = 0.05,
|
|
grid_minor_y_size = 0.05,
|
|
caption_position_to_plot = TRUE,
|
|
...
|
|
) {
|
|
|
|
# To do :
|
|
# - add facet theming
|
|
|
|
if (!initiative %in% c("reach", "default"))
|
|
rlang::stop(
|
|
c(
|
|
paste0("There is no initiative '", initiative, " to be used with theme_reach()."),
|
|
"i" = paste0("initiative should be either 'reach', 'agora' or 'default'")
|
|
)
|
|
)
|
|
|
|
# Basic simple theme
|
|
# theme_reach <- ggplot2::theme_bw()
|
|
|
|
theme_reach <- ggplot2::theme(
|
|
# Title - design
|
|
title = ggplot2::element_text(
|
|
family = font_family,
|
|
color = title_color,
|
|
size = title_size,
|
|
face = title_font_face
|
|
),
|
|
# Text - design
|
|
text = ggplot2::element_text(
|
|
family = font_family,
|
|
color = text_color,
|
|
size = text_size,
|
|
face = text_font_face
|
|
),
|
|
# Default legend to right position
|
|
legend.position = legend_position,
|
|
# Defaut legend to vertical direction
|
|
legend.direction = legend_direction,
|
|
# set panel background color
|
|
panel.background = ggplot2::element_rect(
|
|
fill = panel_background_color
|
|
),
|
|
# Remove background for legend key
|
|
legend.key = ggplot2::element_blank(),
|
|
# Text sizes
|
|
axis.text = ggplot2::element_text(
|
|
size = axis_text_size,
|
|
family = font_family,
|
|
face = axis_text_font_face,
|
|
color = axis_text_color
|
|
),
|
|
axis.title = ggplot2::element_text(
|
|
size = axis_title_size,
|
|
family = font_family,
|
|
face = axis_title_font_face,
|
|
color = axis_title_color),
|
|
# Wrap title
|
|
plot.title = ggtext::element_textbox_simple(),
|
|
plot.subtitle = ggtext::element_textbox_simple(),
|
|
plot.caption = ggtext::element_textbox_simple(),
|
|
legend.title = ggplot2::element_text(
|
|
size = legend_title_size,
|
|
face = legend_title_font_face,
|
|
family = font_family,
|
|
color = legend_title_color),
|
|
legend.text = ggplot2::element_text(
|
|
size = legend_text_size,
|
|
face = legend_text_font_face,
|
|
family = font_family,
|
|
color = legend_text_color
|
|
),
|
|
axis.text.x = ggplot2::element_text(
|
|
angle = axis_text_x_angle,
|
|
vjust = axis_text_x_vjust,
|
|
hjust = axis_text_x_hjust
|
|
)
|
|
)
|
|
|
|
# Position of title
|
|
if (title_position_to_plot) theme_reach <- theme_reach +
|
|
ggplot2::theme(
|
|
plot.title.position = "plot"
|
|
)
|
|
|
|
if (caption_position_to_plot) theme_reach <- theme_reach +
|
|
ggplot2::theme(
|
|
plot.caption.position = "plot"
|
|
)
|
|
# Position of caption
|
|
|
|
# Axis lines ?
|
|
if (axis_x & axis_y) {
|
|
theme_reach <- theme_reach +
|
|
ggplot2::theme(
|
|
axis.line = ggplot2::element_line(color = text_color))
|
|
}
|
|
|
|
if (!axis_x) {
|
|
theme_reach <- theme_reach +
|
|
ggplot2::theme(
|
|
axis.line.x = ggplot2::element_blank(),
|
|
axis.ticks.x = ggplot2::element_blank(),
|
|
axis.text.x = ggplot2::element_blank())
|
|
}
|
|
|
|
if (!axis_y) {
|
|
theme_reach <- theme_reach +
|
|
ggplot2::theme(
|
|
axis.line.y = ggplot2::element_blank(),
|
|
axis.ticks.y = ggplot2::element_blank(),
|
|
axis.text.y = ggplot2::element_blank())
|
|
}
|
|
|
|
# X - major grid lines
|
|
if (!grid_major_x) theme_reach <- theme_reach +
|
|
ggplot2::theme(
|
|
panel.grid.major.x = ggplot2::element_blank()
|
|
) else theme_reach <- theme_reach +
|
|
ggplot2::theme(
|
|
panel.grid.major.x = ggplot2::element_line(
|
|
color = grid_major_color,
|
|
linewidth = grid_major_x_size)
|
|
)
|
|
|
|
# Y - major grid lines
|
|
if (!grid_major_y) theme_reach <- theme_reach +
|
|
ggplot2::theme(
|
|
panel.grid.major.y = ggplot2::element_blank()
|
|
) else theme_reach <- theme_reach +
|
|
ggplot2::theme(
|
|
panel.grid.major.y = ggplot2::element_line(
|
|
color = grid_major_color,
|
|
linewidth = grid_major_y_size)
|
|
)
|
|
|
|
# X - minor grid lines
|
|
if (!grid_minor_x) theme_reach <- theme_reach +
|
|
ggplot2::theme(
|
|
panel.grid.minor.x = ggplot2::element_blank()
|
|
) else theme_reach <- theme_reach +
|
|
ggplot2::theme(
|
|
panel.grid.minor.x = ggplot2::element_line(
|
|
color = grid_minor_color,
|
|
linewidth = grid_minor_x_size)
|
|
)
|
|
|
|
# Y - minor grid lines
|
|
if (!grid_minor_y) theme_reach <- theme_reach +
|
|
ggplot2::theme(
|
|
panel.grid.minor.y = ggplot2::element_blank()
|
|
) else theme_reach <- theme_reach +
|
|
ggplot2::theme(
|
|
panel.grid.minor.y = ggplot2::element_line(
|
|
color = grid_minor_color,
|
|
linewidth = grid_minor_y_size)
|
|
)
|
|
|
|
# Other parameters
|
|
theme_reach <- theme_reach + ggplot2::theme(...)
|
|
|
|
# Add reach color palettes by default
|
|
# (reversed guide is defaulted to TRUE for natural reading)
|
|
theme_reach <- list(
|
|
theme_reach,
|
|
scale_color(initiative = initiative, palette = palette, discrete = discrete, reverse = reverse, reverse_guide = legend_reverse),
|
|
scale_fill(initiative = initiative, palette = palette, discrete = discrete, reverse = reverse, reverse_guide = legend_reverse)
|
|
)
|
|
|
|
|
|
return(theme_reach)
|
|
|
|
}
|