| Title: | Configurable Reporting on your External Compute Environment |
|---|---|
| Description: | Runs a series of configurable tests against a user's compute environment. This can be used for checking that things like a specific directory or an environment variable is available before you start an analysis. Alternatively, you can use the package's situation report when filing error reports with your compute infrastructure. |
| Authors: | Mark Sellors [aut, cre] |
| Maintainer: | Mark Sellors <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 0.0.3.9000 |
| Built: | 2024-11-22 03:05:14 UTC |
| Source: | https://github.com/sellorm/envstat |
Opens an envstat config file in your in your editor.
Supports either the RStudio IDE, or the R default editor from
getOption("editor")
edit_envstat(filepath = "~/.envstat")edit_envstat(filepath = "~/.envstat")
filepath |
path to the config file |
the path to the config file invisibly
## Not run: # By default envstat uses a config file in your home directory envstat::edit_envstat() # But you can tell it to use a different config file if you prefer envstat::edit_envstat(filepath = "/tmp/config.yml") ## End(Not run)## Not run: # By default envstat uses a config file in your home directory envstat::edit_envstat() # But you can tell it to use a different config file if you prefer envstat::edit_envstat(filepath = "/tmp/config.yml") ## End(Not run)
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.
sitrep(silent = FALSE, path = "~/.envstat")sitrep(silent = FALSE, path = "~/.envstat")
silent |
boolean disables printed output |
path |
path to the envstat config file |
TRUE/FALSE invisibly, to indicate all checks pass/fail
## 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) ## End(Not run)## 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) ## End(Not run)
Create a new skeleton configuration file
use_envstat(filepath = "~/.envstat", source = NULL, consent = FALSE)use_envstat(filepath = "~/.envstat", source = NULL, consent = FALSE)
filepath |
path to the config file |
source |
customise the source of the example config file |
consent |
boolean indicates user consent, default FALSE |
TRUE/FALSE invisibly to indicate success/failure
## Not run: # By default envstat uses a config file in your home directory envstat::use_envstat() # But you can tell it to use a different config file if you prefer envstat::use_envstat(filepath = "/tmp/config.yml") # During normal operation use_envstat uses a default config file that ships # with the package, but you can specify your own if you have one. This can # be useful in settings such as multi-user server deployments of R, as many # users could use the same base configuration file and personalise it for # their own specific use case. envstat::use_envstat(source = "/shared/corp_envstat_conf.yml") ## End(Not run)## Not run: # By default envstat uses a config file in your home directory envstat::use_envstat() # But you can tell it to use a different config file if you prefer envstat::use_envstat(filepath = "/tmp/config.yml") # During normal operation use_envstat uses a default config file that ships # with the package, but you can specify your own if you have one. This can # be useful in settings such as multi-user server deployments of R, as many # users could use the same base configuration file and personalise it for # their own specific use case. envstat::use_envstat(source = "/shared/corp_envstat_conf.yml") ## End(Not run)