R/theme_du_bois.R

In add2ggplot: Add to 'ggplot2'

#' Use Du Bois's theme
#'
#' \code{theme_du_bois} is one of ggplot themes for ploting.
#'
#' The function I developed originates from this
#' \href{https://github.com/mtthwastn/statswithmatt/tree/master/ggplot2-meets-w-e-b-du-bois}{GitHub Repository}
#' by the statistician Matthew A.
#' He reproduces the sort of images originated from
#' \href{https://rationalwiki.org/wiki/W._E._B._Du_Bois}{W.E.B. Du Bois}.
#'
#' @param font_name A Character.
#' @return The function to use \code{+} in the ggplot workflow.
#' @author Jiaxiang Li
#'
#' @import ggplot2
#' @export
#' @examples
#' datasets::mtcars %>%
#'   ggplot2::ggplot(ggplot2::aes(mpg, disp)) +
#'   ggplot2::geom_point() +
#'   theme_du_bois()
theme_du_bois <- function(font_name = '') {
    ggplot2::theme_gray(base_family = font_name) %+replace%
        ggplot2::theme(
            plot.background = ggplot2::element_rect(
                fill = "antiquewhite2",
                # antiquewhite: antique white
                # 有一种古老画布的感觉
                color = "antiquewhite2"
            ),
            # ggplot2::element_rect: borders and backgrounds.
            # 定义边界和背景图
            # color: Line/border colour.
            # fill : Fill colour.
            panel.background = ggplot2::element_rect(
                fill = "antiquewhite2",
                color = "antiquewhite2"
            ),
            plot.title = ggplot2::element_text(
                hjust = 0.5,
                # hjust
                # Horizontal justification (in [0, 1])
                # 因此 0.5 是居中
                face = "bold"
                # face
                # Font face ("plain", "italic", "bold", "bold.italic")
            ),
            plot.subtitle = ggplot2::element_text(hjust = 0.5)
        )
}