R/lum_0_100.R

In R.AlphA.Home: Feel at Home using R, Thanks to Shortcuts Functions Making it Simple

#' @title Adjust the Brightness of the Graphics Window for confortable viewing
#' when using ggplot2
#' @description Modifies the brightness level of the active graphics window by
#' adjusting its background color.
#'
#' This is especially useful when using dark RStudio themes, where a 100% white
#' graphic window creates an unconfortable contrast.
#'
#' @param lum Numeric. Brightness level, ranging from 0 (completely dark)
#' to 100 (maximum brightness).
#'
#' @return no return value : only apply the theme_set() function
#' @importFrom grDevices rgb
#' @import ggplot2
#' @export
#'
lum_0_100 <- function(lum = NULL) {

	if (!is.numeric(lum) || lum < 0 || lum > 100) {
		stop("lum must be a numeric value between 0 and 100.")
	}

	lum_pc_leg <- lum/100
	hex_leg <- rgb(lum_pc_leg,lum_pc_leg,lum_pc_leg)

	dark_adjustments <- theme(
		plot.background = element_rect(fill = ret_lum(hex_leg,0.7))
		, legend.background = element_rect(fill = hex_leg)
		, panel.background = element_rect(fill = hex_leg)
		, panel.grid.major = element_line(color = ret_lum(hex_leg, 0.7))
		, panel.grid.minor = element_line(color = ret_lum(hex_leg, 0.7))
		, axis.text = element_text(color = ret_lum(hex_leg,0.4))
		, legend.key = element_rect(fill = ret_lum(hex_leg,0.8))
	)

	theme_set(theme_get()+dark_adjustments)
}