Skip to contents

affiner_options() returns the affiner package's global options.

Usage

affiner_options(..., default = FALSE)

Arguments

...

affiner 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

affiner for a high-level description of relevant global options.

Examples

  affiner_options()
#> $affiner_angular_unit
#> [1] "degrees"
#> 
#> $affiner_grid_unit
#> [1] "inches"
#> 

  affiner_options(default = TRUE)
#> $affiner_angular_unit
#> [1] "degrees"
#> 
#> $affiner_grid_unit
#> [1] "inches"
#> 

  affiner_options(affiner_angular_unit = "pi-radians")
#> $affiner_angular_unit
#> [1] "pi-radians"
#> 
#> $affiner_grid_unit
#> [1] "inches"
#>