Skip to contents

Configure report template

Source: R/configure_report.R
configure_report.Rd

This function configures the content of the to-be-generated data profiling report.

Usage

configure_report(
  add_introduce = TRUE,
  introduce_args = list(),
  global_ggtheme = quote(theme_gray()),
  global_theme_config = list()
)

Arguments

add_introduce

add introduce? Default is TRUE.

introduce_args

arguments to be passed to introduce. Default is list().

global_ggtheme

global setting for theme.Default is quote(theme_gray()).

global_theme_config

global setting for theme. Default is list().

Note

Individual settings will overwrite global settings. For example: if intro_args has ggtheme set to theme_light() while global_ggtheme is set to theme_gray(), theme_light() will be used.

When setting global themes using global_ggtheme, please pass an unevaluated call to the theme function, e.g., quote(theme_light()).

See also

create_report

Examples

## Get default configuration
configure_report()
#> $introduce
#> list()
#> 

## Set global theme
configure_report(global_ggtheme = quote(theme_light(base_size = 20L)))
#> $introduce
#> list()
#>