R/theme_floralShoppe.R

In moldach/vapoRwave: Vaporwave themes and color palettes for ggplot2 graphics

#' Floral Shoppe Theme
#' @description
#' ggplot2 plot theme based on the Floral Shoppe album cover
#'
#' @references https://beerontherug.bandcamp.com/album/floral-shoppe
#' @seealso [ggplot2::theme]
#'
#' @param font Base text family
#' @param main.text.color Color of main text
#' @param sub.text.color Color of smaller text
#' @param base.size Base text size
#' @param plot.background.color Color of plot background, passed to `plot.background`
#' @param legend.position Position of legend
#' @param panel.border.color Color of plot panel border
#' @param panel.background Background panel color
#' @param panel.grid.color Color of the panel grid
#' @param axis.text.color Color of axis text
#' @param axis.text.size Size of axis text
#' @param subtitle.size Size of subtitle
#' @param legend.text Size of legend
#' @param legend.title Size of legend title
#' @param axis.title.size Size of axis title
#' @param title.size Size of title
#' @importFrom ggplot2 element_blank element_line element_rect element_text margin theme_minimal
#'
#' @export
floral_shoppe <- function(
        font = "VCR OSD Mono",
        main.text.color = "#6CFFB9",
        sub.text.color = "#6CFFB9",
        base.size = 15,
        plot.background.color = "#FF819C",
        legend.position = "right",
        panel.border.color = "black",
        panel.background = "black",
        panel.grid.color = "#6CFFB9",
        axis.text.color = "#6CFFB9",
        axis.text.size = base.size * 0.6666667,
        subtitle.size = base.size * 0.8,
        legend.text = base.size * 0.8,
        legend.title = base.size * 0.93,
        axis.title.size = base.size * 0.8,
        title.size = 15
) {

        th <- ggplot2::theme_minimal()

        #Text format:
        #This sets the font, size, type and colour of text for the chart's title
        th$plot.title=ggplot2::element_text(family=font,
                                            size=title.size,
                                            face="bold",
                                            color=main.text.color)
        #This sets the font, size, type and colour of text for the chart's subtitle, as well as setting a margin between the title and the subtitle
        th$plot.subtitle=ggplot2::element_text(family=font,
                                               size=subtitle.size,
                                               face="bold",
                                               color=main.text.color,
                                               margin=ggplot2::margin(9,0,9,0))
        #Legend format
        #This sets the position and alignment of the legend, removes a title and backround for it and sets the requirements for any text within the legend. The legend may often need some more manual tweaking when it comes to its exact position based on the plot coordinates.
        th$legend.position = legend.position
        th$legend.text.align=0
        th$legend.background=ggplot2::element_blank()
        th$legend.key=ggplot2::element_blank()
        th$legend.text=ggplot2::element_text(family=font,
                                             size=legend.text,
                                             color=main.text.color)
        th$legend.title=ggplot2::element_text(family=font,
                                              size=legend.title,
                                              color=main.text.color)

        #Axis format
        #This sets the text font, size and colour for the axis test, as well as setting the margins and removes lines and ticks. In some cases, axis lines and axis ticks are things we would want to have in the chart - the cookbook shows examples of how to do so.
        th$axis.title.x=ggplot2::element_text(family=font,
                                              size=axis.title.size,
                                              color=main.text.color)
        th$axis.title.y=th$axis.title.x

        th$axis.text=ggplot2::element_text(family=font,
                                           size=axis.text.size,
                                           color=main.text.color)

        th$axis.text.x=ggplot2::element_text(margin=ggplot2::margin(5, b=10))
        th$axis.text.y = ggplot2::element_text(margin=ggplot2::margin(l = 10))
        th$axis.ticks=ggplot2::element_blank()
        th$axis.line=ggplot2::element_blank()

        #Grid lines
        #This removes all minor gridlines and adds major y gridlines. In many cases you will want to change this to remove y gridlines and add x gridlines. The cookbook shows you examples for doing so
        th$panel.grid.minor=ggplot2::element_blank()
        th$panel.grid=ggplot2::element_line(linetype=3, color=panel.grid.color, size=0.2)

        #Blank background
        #This sets the panel background as blank, removing the standard grey ggplot background colour from the plot
        th$panel.background = ggplot2::element_rect(
                fill=panel.background,
                colour = NA
        )
        th$plot.background = ggplot2::element_rect(
                fill = plot.background.color,
                colour = NA
        )
        th$panel.border = ggplot2::element_rect(
                color = panel.border.color,
                fill = NA,
                linetype = "solid",
                size = 0.75
        )
        th$plot.caption = ggplot2::element_text(color=main.text.color)

        #Strip background (#This sets the panel background for facet-wrapped plots to white, removing the standard grey ggplot background colour and sets the title size of the facet-wrap title to font size 22)
        th$strip.background = ggplot2::element_rect(fill=panel.background)
        th$strip.text= ggplot2::element_text(colour = main.text.color,
                                             size  = 12,
                                             hjust = 0)

        return (th)

}