R/theme_digikala.R

In mcnakhaee/delgosha: An opinionated package with additional RTL ggplot2 themes and palettes for Persian

#' An opinionated ggplot2 theme based on Digikala's used colors and plots
#'
#' @param base_font
#' @param base_size
#' @param plot_title_font
#' @param plot_title_size
#' @param plot_title_face
#' @param plot_title_margin
#' @param subtitle_font
#' @param subtitle_size
#' @param subtitle_face
#' @param subtitle_margin
#' @param strip_text_font
#' @param strip_text_size
#' @param strip_text_face
#' @param strip_text_margin
#' @param caption_font
#' @param caption_size
#' @param caption_face
#' @param caption_margin
#' @param legend_font
#' @param legend_font_size
#' @param legend_color
#' @param legend_title_size
#' @param legend_position
#' @param axis_text_size
#' @param axis_title_font
#' @param axis_title_size
#' @param axis_title_face
#' @param axis_title_just
#' @param plot_margin
#' @param grid_col
#' @param grid
#' @param axis_col
#' @param axis
#' @param ticks
#'
#' @return
#' @export
#'
#' @examples
theme_digikala <- function(base_font = "WeblogmaYekan",
                           base_size = 12.5,
                           plot_title_font = "WeblogmaYekan",
                           plot_title_size = 30,
                           plot_title_face = "bold",
                           plot_title_margin = 10,
                           subtitle_font = base_font,
                           subtitle_size = 12,
                           subtitle_face = "plain",
                           subtitle_margin = 15,
                           strip_text_font = base_font,
                           strip_text_size = 12,
                           strip_text_face = "plain",
                           strip_text_margin = 10,
                           caption_font = base_font,
                           caption_size = 9,
                           caption_face = "italic",
                           caption_margin = 10,
                           legend_font = "WeblogmaYekan",
                           legend_font_size = 10,
                           legend_color = '#76787A',
                           legend_title_size = 12,
                           legend_position = 'top',
                           axis_text_size = base_size,
                           axis_title_font = subtitle_font,
                           axis_title_size = 12,
                           axis_title_face = "plain",
                           axis_title_just = "rt",
                           plot_margin = margin(30, 30, 30, 30),
                           grid_col = "#cccccc",
                           grid = TRUE,
                           axis_col = "#cccccc",
                           axis = FALSE,
                           ticks = FALSE) {
  def_fore <- '#19D9FA' #blue
  curve_col <- "#FB112D" #red
  text_color <- '#76787A'
  axis_line_color <- '#C9C9C9'
  axis_text_color <- '#717171'

  thm <-
    ggplot2::theme_minimal(base_family = base_font, base_size = base_size)

  thm <- thm + theme(legend.position = 'top')
  thm <-
    thm + theme(
      text = element_text(color = text_color),
      plot.title = element_text(
        family =  plot_title_font,
        hjust = 1,
        margin = margin(t = plot_title_margin, b =
                          plot_title_margin),
        face = plot_title_face,
        color = 'black'
      ),
      plot.subtitle = element_text(
        family =  plot_title_font,
        hjust = 1,
        margin = margin(b = subtitle_margin),
        face = subtitle_face,
        color = 'gray60'
      ),
      plot.caption = element_text(
        family =  plot_title_font,
        hjust = 0,
        face = caption_face,
        color = 'gray70'
      ),
      axis.text = element_text(color = axis_text_color)

    )


  thm <-
    thm + theme(
      axis.title.y = element_text(margin = margin(
        t = 0,
        r = 10,
        b = 0,
        l = 0
      )),
      axis.title.x = element_text(margin = margin(
        t = 10,
        r = 0,
        b = 0,
        l = 0
      )),
      axis.line = element_line(color = axis_line_color, size = 0.15),
      panel.grid = element_blank()
    )

  thm <-
    thm + theme(
      strip.text = element_text(
        color = text_color,
        size = strip_text_size,
        margin = margin(t = strip_text_margin, b = strip_text_margin)
      ),
      panel.spacing.x = unit(2, "lines"),
      panel.spacing.y = unit(2, "lines"),
      panel.spacing = plot_margin
    )


  ggplot2::update_geom_defaults("point", list(colour = def_fore))
  ggplot2::update_geom_defaults("line", list(colour = def_fore))
  ggplot2::update_geom_defaults("curve", list(colour = curve_col))
  ggplot2::update_geom_defaults("area", list(colour = def_fore, fill = def_fore))
  ggplot2::update_geom_defaults("rect", list(colour = def_fore, fill = def_fore))
  ggplot2::update_geom_defaults("density", list(colour = def_fore, fill =
                                                  def_fore))
  ggplot2::update_geom_defaults("bar", list(colour = def_fore, fill = def_fore))
  ggplot2::update_geom_defaults("col", list(colour = def_fore, fill = def_fore))

  ggplot2::update_geom_defaults("text", list(colour = text_color, family = base_font))

  thm
}