R/themes.R

In Ilia-Kosenkov/sciplotr: GGplots with scientific themes

#' @title theme_sci
#' @description Generates scientific theme.
#' @param ticks Controls the ticks size (and direction).
#' @param ticks.minor Controls the minor ticks size (and direction).
#' @param text.size Text font size by default.
#' @param title.size Title (labels') font size by default.
#' @param text.margin Text margin (added to the tick offset)
#' @param title.margin Title margin (added to the tick offset)
#' @param text.color Color of the text.
#' @param plot.margin,legend.position,legend.justification,legend.background,legend.spacing,panel.grid.major.x,panel.grid.major.y,panel.grid.minor.x,panel.grid.minor.y,strip.text.x,strip.text.y,panel.spacing,strip.switch.pad.grid,strip.switch.pad.wrap,strip.placement,strip.background Explicitly overriden base parameters.
#' @param facet.lab.x,facet.lab.y Position of facet labels, in \code{unit}.
#' @param facet.lab A \code{ggplot2::element_text} representing facet label.
#' @param validate Indicates whetehr \code{theme} should be validated.
#'  \strong{Currently only works when} \code{FALSE} (which is the default value).
#' @param ... Other parameters passed to \code{ggplot2::theme}
#' @return A theme object.
#' @export
theme_sci <- function(
                        ticks = -u_(10$pt),
                        ticks.minor = ticks / 2,
                        text.size = 10,
                        title.size = 15,
                        text.margin = u_(5$pt),
                        title.margin = u_(5$pt),
                        plot.margin = u_(0 ~ npc),
                        text.color = "#000000",
                        facet.lab.x = npc_(0.07),
                        facet.lab.y = npc_(0.93),
                        facet.lab = ggplot2::element_text(size = title.size),
#--------------------------------------------------#
                        legend.position = vctrs::vec_c(1, 0),
                        legend.justification = vctrs::vec_c(1.05, -0.05),
                        legend.background = element_blank(),
                        legend.spacing = u_(0 ~ null),
#--------------------------------------------------#
                        panel.grid.major.x = ggplot2::element_blank(),
                        panel.grid.major.y = ggplot2::element_blank(),
                        panel.grid.minor.x = ggplot2::element_blank(),
                        panel.grid.minor.y = ggplot2::element_blank(),
                        strip.text.x = ggplot2::element_text(size = title.size, margin = title.margin),
                        strip.text.y = ggplot2::element_text(size = title.size, margin = title.margin, angle = 90),
                        panel.spacing = u_(0 ~ null),
                        strip.switch.pad.grid = u_(0 ~ null),
                        strip.switch.pad.wrap = u_(0 ~ null),
                        strip.placement = "outside",
                        strip.background = ggplot2::element_blank(),
                        ..., validate = TRUE) {

    # Asserts
    assertthat::assert_that(grid::is.unit(ticks), length(ticks) == 1L)
    assertthat::assert_that(grid::is.unit(ticks.minor), length(ticks.minor) == 1L)
    text.size <- vec_assert(vec_cast(text.size, double()), size = 1L)
    title.size <- vec_assert(vec_cast(title.size, double()), size = 1L)
    assertthat::assert_that(grid::is.unit(text.margin), grid::is.unit(title.margin))
    assertthat::assert_that(grid::is.unit(plot.margin))
    vctrs::vec_assert(text.color, character(), 1L)

    text.margin <- mar_(text.margin)
    title.margin <- mar_(title.margin)
    plot.margin <- mar_(plot.margin)

    theme_bw() +
    theme(
        plot.margin = plot.margin,
        panel.grid.major.x = panel.grid.major.x,
        panel.grid.major.y = panel.grid.major.y,
        panel.grid.minor.x = panel.grid.minor.x,
        panel.grid.minor.y = panel.grid.minor.y,
        #---------------------------------------
        sciplotr.facet.lab = facet.lab,
        sciplotr.facet.lab.pos.x = facet.lab.x,
        sciplotr.facet.lab.pos.y = facet.lab.y,
        sciplotr.axis.ticks.minor.length = ticks.minor,
        #---------------------------------------
        axis.ticks.length = ticks,
        axis.text.x =
                ggplot2::element_text(size = text.size,
                    margin = with_mar(text.margin, t := ~.x - ticks),
                    colour = text.color),
        axis.text.y =
                ggplot2::element_text(size = text.size,
                    margin = with_mar(text.margin, r := ~.x - ticks),
                    colour = text.color),
        axis.text.y.right =
                ggplot2::element_text(size = text.size,
                    margin = with_mar(text.margin, l := ~.x - ticks),
                    colour = text.color),
        axis.text.x.top =
                ggplot2::element_text(size = text.size,
                    margin = with_mar(text.margin, b := ~.x - ticks),
                    colour = text.color),
        #---------------------------------#
        axis.title.x =
                ggplot2::element_text(size = title.size,
                     margin = with_mar(title.margin, t := ~.x - ticks),
                     colour = text.color),
        axis.title.y =
                ggplot2::element_text(size = title.size,
                    margin = with_mar(title.margin, r := ~.x - ticks),
                    colour = text.color),
        axis.title.y.right =
                ggplot2::element_text(size = title.size,
                    margin = with_mar(title.margin, l := ~.x - ticks),
                    colour = text.color),
        axis.title.x.top =
                ggplot2::element_text(size = title.size,
                    margin = with_mar(title.margin, b := ~.x - ticks),
                    colour = text.color),
        #---------------------------------#
        legend.position = legend.position,
        legend.justification = legend.justification,
        legend.background = legend.background,
        legend.spacing = legend.spacing,
        #---------------------------------#
        strip.placement = strip.placement,
        strip.background = strip.background,
        strip.text.x = strip.text.x,
        strip.text.y = strip.text.y,
        strip.switch.pad.grid = strip.switch.pad.grid,
        strip.switch.pad.wrap = strip.switch.pad.wrap,
        #---------------------------------#
        panel.spacing = panel.spacing,
        #---------------------------------#

        ..., validate = validate)
}