| Title: | Configurable Reporting on your External Compute Environment |
| Version: | 0.0.3 |
| 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. |
| URL: | https://envstat.sellorm.com |
| BugReports: | https://github.com/sellorm/envstat/issues |
| License: | MIT + file LICENSE |
| Encoding: | UTF-8 |
| RoxygenNote: | 7.2.0 |
| Imports: | cli, httr2, rstudioapi, yaml |
| Suggests: | covr, testthat (≥ 3.0.0) |
| Config/testthat/edition: | 3 |
| NeedsCompilation: | no |
| Packaged: | 2022-06-14 15:11:32 UTC; sellorm |
| Author: | Mark Sellors [aut, cre] |
| Maintainer: | Mark Sellors <rstats@5vcc.com> |
| Repository: | CRAN |
| Date/Publication: | 2022-06-14 15:20:02 UTC |
Edit an envstat configuration file
Description
Opens an envstat config file in your in your editor.
Supports either the RStudio IDE, or the R default editor from
getOption("editor")
Usage
edit_envstat(filepath = "~/.envstat")
Arguments
filepath |
path to the config file |
Value
the path to the config file invisibly
Examples
## 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)
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)
## End(Not run)
Create a new skeleton configuration file
Description
Create a new skeleton configuration file
Usage
use_envstat(filepath = "~/.envstat", source = NULL, consent = FALSE)
Arguments
filepath |
path to the config file |
source |
customise the source of the example config file |
consent |
boolean indicates user consent, default FALSE |
Value
TRUE/FALSE invisibly to indicate success/failure
Examples
## 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)