checkLightMode: check lightMode for light background color

In jmw86069/jamba: Just Analysis Methods Base

check lightMode for light background color

Description

check lightMode for light background color

Usage

checkLightMode(lightMode = NULL, ...)

Arguments

lightMode	logical or NULL, indicating whether the lightMode parameter has been defined in the function call.
...	Additional arguments are ignored.

Details

Check the lightMode status through function parameter, options, or environment variable. If the function defines lightMode, it is used as-is. If lightMode is NULL, then options("jam.lightMode") is used if defined. Otherwise, it tries to detect whether the R session is running inside Rstudio using the environmental variable "RSTUDIO", and if so it assumes lightMode==TRUE.

To set a default lightMode, add options("jam.lightMode"=TRUE) to .Rprofile, or to the relevant R script.

Value

logical or length=1, indicating whether lightMode is defined

See Also

Other jam practical functions: breakDensity(), call_fn_ellipsis(), check_pkg_installed(), colNum2excelName(), color_dither(), exp2signed(), getAxisLabel(), isFALSEV(), isTRUEV(), jargs(), kable_coloring(), lldf(), log2signed(), middle(), minorLogTicks(), newestFile(), printDebug(), reload_rmarkdown_cache(), renameColumn(), rmInfinite(), rmNA(), rmNAs(), rmNULL(), setPrompt()

Examples

checkLightMode(TRUE);
checkLightMode();

jmw86069/jamba documentation built on June 9, 2025, 5:52 a.m.