R: 'rcmd_safe_env' returns a set of environment variables that...

rcmd_safe_env {callr} | R Documentation

## `rcmd_safe_env` returns a set of environment variables that are more appropriate for `rcmd_safe()`. It is exported to allow manipulating these variables (e.g. add an extra one), before passing them to the `rcmd()` functions.

### Description

It currently has the following variables:

- `CYGWIN="nodosfilewarning"`: On Windows, do not warn about MS-DOS style file names.

- `R_TESTS=""` This variable is set by `R CMD check`, and makes the child R process load a startup file at startup, from the current working directory, that is assumed to be the `/test` dirctory of the package being checked. If the current working directory is changed to something else (as it typically is by `testthat`, then R cannot start. Setting it to the empty string ensures that `callr` can be used from unit tests.

- `R_BROWSER="false"`: typically we don't want to start up a browser from the child R process.

- `R_PDFVIEWER="false"`: similarly for the PDF viewer.

- `R_ENVIRON_USER=tempfile()`: this prevents R from loading the user `.Renviron`.

### Usage

    rcmd_safe_env()

### Details

Note that `callr` also sets the `R_LIBS`, `R_LIBS_USER`, `R_LIBS_SITE`, `R_PROFILE` and `R_PROFILE_USER` environment variables appropriately, unless these are set by the user in the `env` argument of the `r`, etc. calls.

### Value

A named character vector of environment variables.

[Package callr version 2.0.2 Index]