bm_options: Get bittermelon options

View source: R/bm_options.R

bm_optionsR Documentation

Get bittermelon options

Description

bm_options() returns the bittermelon packages 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()

  bm_options(default = TRUE)

  bm_options(bittermelon.compress = "vertical")

trevorld/bittermelon documentation built on Dec. 24, 2024, 10:33 p.m.