Skip to contents

Get dee options

Source: R/dee_options.R
dee_options.Rd

dee_options() returns the dee package's global options.

Usage

dee_options(..., default = FALSE)

Arguments

...

dee package options using name = value. The return list will use any of these instead of the current/default values.

default

If TRUE return the default values instead of current values.

Value

A list of option values. Note this function does not set option values itself but this list can be passed to options(), withr::local_options(), or withr::with_options().

See also

dee-package for a high-level description of relevant global options.

Examples

  dee_options()
#> $dee.attrs
#> NULL
#> 
#> $dee.background_color
#> NULL
#> 
#> $dee.digits
#> [1] Inf
#> 
#> $dee.fill
#> NULL
#> 
#> $dee.height
#> NULL
#> 
#> $dee.origin_at_bottom
#> [1] FALSE
#> 
#> $dee.sep
#> [1] ","
#> 
#> $dee.stroke
#> NULL
#> 
#> $dee.stroke_width
#> NULL
#> 
#> $dee.width
#> NULL
#> 

  dee_options(default = TRUE)
#> $dee.attrs
#> NULL
#> 
#> $dee.background_color
#> NULL
#> 
#> $dee.digits
#> [1] Inf
#> 
#> $dee.fill
#> NULL
#> 
#> $dee.height
#> NULL
#> 
#> $dee.origin_at_bottom
#> [1] FALSE
#> 
#> $dee.sep
#> [1] ","
#> 
#> $dee.stroke
#> NULL
#> 
#> $dee.stroke_width
#> NULL
#> 
#> $dee.width
#> NULL
#> 

  dee_options(dee.height = 100, dee.width = 100, dee.origin_at_bottom = TRUE)
#> $dee.attrs
#> NULL
#> 
#> $dee.background_color
#> NULL
#> 
#> $dee.digits
#> [1] Inf
#> 
#> $dee.fill
#> NULL
#> 
#> $dee.height
#> [1] 100
#> 
#> $dee.origin_at_bottom
#> [1] TRUE
#> 
#> $dee.sep
#> [1] ","
#> 
#> $dee.stroke
#> NULL
#> 
#> $dee.stroke_width
#> NULL
#> 
#> $dee.width
#> [1] 100
#>