envstat (version 0.0.3)

sitrep: Output an environment status situation report

Description

Reports on the availability of certain features of your compute infrastructure, for example, environment variables, or a specific RStudio Package Manager instance. Configure the tests with the use_envstat and edit_envstat functions.

Usage

sitrep(silent = FALSE, path = "~/.envstat")

Arguments

silent

boolean disables printed output

path

path to the envstat config file

Value

TRUE/FALSE invisibly, to indicate all checks pass/fail

Examples

# NOT RUN {
# By default envstat uses a config file in your home directory
envstat::sitrep()

# But you can tell it to use a different config file if you prefer
envstat::sitrep(path = "/tmp/config.yml")

# sitrep can also run silently, so that it can be used programatically
envstat::sitrep(silent = TRUE)
# }