resolve_ggplot2_args: Resolving and reducing multiple 'ggplot2_args' objects

In teal.widgets: 'shiny' Widgets for 'teal' Applications

Resolving and reducing multiple ggplot2_args objects

Description

Resolving and reducing multiple ggplot2_args objects. This function is intended to utilize user provided settings, defaults provided by the module creator and also teal option. See Details, below, to understand the logic.

Usage

resolve_ggplot2_args(
  user_plot = ggplot2_args(),
  user_default = ggplot2_args(),
  module_plot = ggplot2_args(),
  app_default = getOption("teal.ggplot2_args", ggplot2_args())
)

Arguments

user_plot	(ggplot2_args) end user setup for theme and labs in the specific plot. Created with the ggplot2_args() function. The NULL value is supported.
user_default	(ggplot2_args) end user setup for module default theme and labs. Created with the ggplot2_args() function. The NULL value is supported.
module_plot	(ggplot2_args) module creator setup for theme and labs in the specific plot. Created with the ggplot2_args() function. The NULL value is supported.
app_default	(ggplot2_args) Application level setting. Can be NULL.

Details

The function picks the first non NULL value for each argument, checking in the following order:

1. ggplot2_args argument provided by the end user. Per plot (user_plot) and then default (user_default) setup.

2. app_default global R variable, teal.ggplot2_args.

3. module_plot which is a module creator setup.

Value

ggplot2_args object.

See Also

parse_ggplot2_args() to parse resolved list into list of calls.

Examples

resolve_ggplot2_args(
  user_plot = ggplot2_args(
    lab = list(title = "TITLE"),
    theme = list(title = ggplot2::element_text(size = 20))
  ),
  user_default = ggplot2_args(
    lab = list(x = "XLAB")
  )
)

teal.widgets documentation built on Oct. 10, 2023, 5:07 p.m.