R/set_theme.R

In WarwickCIM/backfillz: MCMC visualisation package

#' Set graphical plot slots of a backfillz object to a theme
#'
#' @param backfillz_object  Backfillz object
#' @param theme             Character specifying theme
#'  (e.g., 'default', 'solarized_dark')
#' @param verbose       Set to TRUE to see function messages
set_theme <- function(backfillz_object, theme = "default", verbose = TRUE) {

  # check inputs
  assertive::is_character(theme)
  assertive::is_s4(backfillz_object)
  stopifnot(class(backfillz_object) == "backfillz")

  # set theme values
  if (theme == "default") {
    if (verbose) {
      message("Setting backfillz object theme to default")
    }
    backfillz_object@theme_name               <- "default"
    backfillz_object@theme_text_family        <- "sans"
    backfillz_object@theme_text_font          <- 1
    backfillz_object@theme_text_font_colour   <- "black"

    backfillz_object@theme_text_cex_title     <- 1.5
    backfillz_object@theme_text_cex_main      <- 1
    backfillz_object@theme_text_cex_axis      <- 0.8

    backfillz_object@theme_text_col_title     <- "grey10"
    backfillz_object@theme_text_col_main      <- "grey60"
    backfillz_object@theme_text_col_axis      <- "grey40"

    backfillz_object@theme_bg_colour          <- "white"
    backfillz_object@theme_mg_colour          <- "grey50"
    backfillz_object@theme_fg_colour          <- "black"
    backfillz_object@theme_alpha              <- 0.7
    backfillz_object@theme_palette            <- list(
      "#FF0000",
      "#0000FF",
      "#FF00FF",
      "#800000",
      "#000080",
      "#FF6347"
    )
  } else if (theme ==  "solarized_dark") {
    if (verbose) {
      message("Setting backfillz object theme to solarized dark")
    }
    backfillz_object@theme_name               <- "solarized_dark"
    backfillz_object@theme_text_family        <- "mono"
    backfillz_object@theme_text_font          <- 1
    backfillz_object@theme_text_font_colour   <- "#2AA198"

    backfillz_object@theme_text_cex_title     <- 2
    backfillz_object@theme_text_cex_main      <- 1
    backfillz_object@theme_text_cex_axis      <- 0.8

    backfillz_object@theme_text_col_title     <- "grey10"
    backfillz_object@theme_text_col_main      <- "grey60"
    backfillz_object@theme_text_col_axis      <- "grey40"

    backfillz_object@theme_bg_colour          <- "#002B36"
    backfillz_object@theme_mg_colour          <- "grey50"
    backfillz_object@theme_fg_colour          <- "#93A1A1"
    backfillz_object@theme_alpha              <- 0.7
    backfillz_object@theme_palette            <- list(
      "#657B83",
      "#D30102",
      "#D33682",
      "#859900",
      "#93A1A1",
      "#268BD2"
    )
  } else if (theme ==  "demo 1") {
    if (verbose) {
      message("Setting backfillz object theme to demo 1")
    }
    backfillz_object@theme_name               <- "demo 1"
    backfillz_object@theme_text_family        <-  "mono"
    backfillz_object@theme_text_font          <-  1
    backfillz_object@theme_text_font_colour   <- "grey20"

    backfillz_object@theme_text_cex_title     <- 1.5
    backfillz_object@theme_text_cex_main      <- 1
    backfillz_object@theme_text_cex_axis      <- 0.6

    backfillz_object@theme_text_col_title     <- "grey10"
    backfillz_object@theme_text_col_main      <- "grey60"
    backfillz_object@theme_text_col_axis      <- "grey40"

    backfillz_object@theme_bg_colour          <- "grey98"
    backfillz_object@theme_mg_colour          <- "grey90"
    backfillz_object@theme_fg_colour          <- "grey40"
    backfillz_object@theme_alpha              <- 0.8
    backfillz_object@theme_palette            <- list(
      "#A3C96D",
      "#DDCF1E",
      "#8E4D91",
      "#003B24",
      "#912B2F",
      "#7C6EAC"
    )
  } else if (theme ==  "demo 2") {
    if (verbose) {
      message("Setting backfillz object theme to demo 2")
    }
    backfillz_object@theme_name               <- "demo 2"
    backfillz_object@theme_text_family        <-  "sans"
    backfillz_object@theme_text_font          <-  1
    backfillz_object@theme_text_font_colour   <- "grey90"

    backfillz_object@theme_text_cex_title     <- 1.5
    backfillz_object@theme_text_cex_main      <- 1
    backfillz_object@theme_text_cex_axis      <- 0.6

    backfillz_object@theme_text_col_title     <- "#F2EEE7"
    backfillz_object@theme_text_col_main      <- "#F2EEE7"
    backfillz_object@theme_text_col_axis      <- "#F2EEE7"

    backfillz_object@theme_bg_colour          <- "#313C3F"
    backfillz_object@theme_mg_colour          <-
     adjustcolor("#313C3F",
      red.f = 1.8,
      green.f = 1.8,
      blue.f = 1.8)
    backfillz_object@theme_fg_colour          <- "#F2EEE7"
    backfillz_object@theme_alpha              <- 0.8
    backfillz_object@theme_palette            <- list(
      "#EEE436",
      "#00AEC7",
      "#C73475",
      "#7FC5D3",
      "#7EB627",
      "#F29530"
    )

  } else {
    if (verbose) {
      message(paste0("Theme not specified so setting backfillz ",
      "object theme to default"))
    }
    backfillz_object@theme_name               <- "default"
    backfillz_object@theme_text_family        <- "sans"
    backfillz_object@theme_text_font          <- 1
    backfillz_object@theme_text_font_colour   <- "black"

    backfillz_object@theme_text_cex_title     <- 2
    backfillz_object@theme_text_cex_main      <- 1
    backfillz_object@theme_text_cex_axis      <- 0.8

    backfillz_object@theme_text_col_title     <- "grey10"
    backfillz_object@theme_text_col_main      <- "grey60"
    backfillz_object@theme_text_col_axis      <- "grey40"

    backfillz_object@theme_bg_colour          <- "white"
    backfillz_object@theme_mg_colour          <- "grey50"
    backfillz_object@theme_fg_colour          <- "black"

    backfillz_object@theme_alpha              <- 0.7
    backfillz_object@theme_palette            <- list(
      "#FF0000",
      "#0000FF",
      "#FF00FF",
      "#800000",
      "#000080",
      "#FF6347"
    )
  }

  return(backfillz_object)
}