with_path: PATH environment variable

with_pathR Documentation

PATH environment variable

Description

Temporarily change the system search path.

Usage

with_path(new, code, action = c("prefix", "suffix", "replace"))

local_path(
  new = list(),
  action = c("prefix", "suffix", "replace"),
  .local_envir = parent.frame()
)

Arguments

new

⁠[character]⁠
New PATH entries

code

[any]
Code to execute in the temporary environment

action

⁠[character(1)]⁠
Should new values "replace", "prefix" (the default) or "suffix" existing paths

.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

Sys.setenv()

Examples

# temporarily modify the system PATH, *prefixing* the current path
with_path(getwd(), Sys.getenv("PATH"))
# temporarily modify the system PATH, *appending* to the current path
with_path(getwd(), Sys.getenv("PATH"), "suffix")

withr documentation built on Oct. 28, 2024, 5:07 p.m.