with_options: Options

In r-lib/withr: Run Code 'With' Temporarily Modified Global State

Options

Description

Temporarily change global options.

Usage

with_options(new, code)

local_options(.new = list(), ..., .local_envir = parent.frame())

Arguments

new, .new	⁠[named list]⁠ New options and their values
code	[any] Code to execute in the temporary environment
...	Additional options and their values
.local_envir	⁠[environment]⁠ The environment to use for scoping.

Value

[any]
The results of the evaluation of the code argument.

See Also

withr for examples

options()

Examples

# number of significant digits to print
getOption("digits")
# modify temporarily the number of significant digits to print
with_options(list(digits = 3), getOption("digits"))
with_options(list(digits = 3), print(pi))

# modify temporarily the character to be used as the decimal point
getOption("digits")
with_options(list(OutDec = ","), print(pi))

# modify temporarily multiple options
with_options(list(OutDec = ",", digits = 3), print(pi))

# modify, within the scope of the function, the number of
# significant digits to print
print_3_digits <- function(x) {
  # assign 3 to the option "digits" for the rest of this function
  # after the function exits, the option will return to its previous
  # value
  local_options(list(digits = 3))
  print(x)
}

print_3_digits(pi)  # returns 3.14
print(pi)           # returns 3.141593

r-lib/withr documentation built on Feb. 2, 2024, 2:03 a.m.