Skip to contents

Get bittermelon options

Source: R/bm_options.R
bm_options.Rd

bm_options() returns the bittermelon package's global options.

Usage

bm_options(..., default = FALSE)

Arguments

...

bittermelon 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

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

Examples

  bm_options()
#> $bittermelon.bg
#> [1] FALSE
#> 
#> $bittermelon.col
#> [1] "transparent" "black"       "grey50"      "grey25"     
#> 
#> $bittermelon.compress
#> [1] "none"
#> 
#> $bittermelon.downscale
#> [1] FALSE
#> 
#> $bittermelon.fg
#> [1] FALSE
#> 
#> $bittermelon.monobit_path
#> [1] "monobit-convert"
#> 
#> $bittermelon.px
#>  [1] "░" "█" "▒" "▓" " " "▗" "▖" "▄" "▝" "▐" "▞" "▟" "▘" "▚" "▌" "▙" "▀" "▜" "▛"
#> [20] "+"
#> 

  bm_options(default = TRUE)
#> $bittermelon.bg
#> [1] FALSE
#> 
#> $bittermelon.col
#> [1] "transparent" "black"       "grey50"      "grey25"     
#> 
#> $bittermelon.compress
#> [1] "none"
#> 
#> $bittermelon.downscale
#> [1] FALSE
#> 
#> $bittermelon.fg
#> [1] FALSE
#> 
#> $bittermelon.monobit_path
#> [1] "monobit-convert"
#> 
#> $bittermelon.px
#>  [1] "░" "█" "▒" "▓" " " "▗" "▖" "▄" "▝" "▐" "▞" "▟" "▘" "▚" "▌" "▙" "▀" "▜" "▛"
#> [20] "+"
#> 

  bm_options(bittermelon.compress = "vertical")
#> $bittermelon.bg
#> [1] FALSE
#> 
#> $bittermelon.col
#> [1] "transparent" "black"       "grey50"      "grey25"     
#> 
#> $bittermelon.compress
#> [1] "vertical"
#> 
#> $bittermelon.downscale
#> [1] FALSE
#> 
#> $bittermelon.fg
#> [1] FALSE
#> 
#> $bittermelon.monobit_path
#> [1] "monobit-convert"
#> 
#> $bittermelon.px
#>  [1] "░" "█" "▒" "▓" " " "▗" "▖" "▄" "▝" "▐" "▞" "▟" "▘" "▚" "▌" "▙" "▀" "▜" "▛"
#> [20] "+"
#>