{"id":14066796,"url":"https://github.com/sellorm/envstat","last_synced_at":"2025-04-21T19:32:41.223Z","repository":{"id":44536273,"uuid":"452867591","full_name":"sellorm/envstat","owner":"sellorm","description":"Environment status reporting for R","archived":false,"fork":false,"pushed_at":"2023-05-02T15:00:31.000Z","size":90,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-01T15:42:29.473Z","etag":null,"topics":["r","rpackage","rstats","rstats-package"],"latest_commit_sha":null,"homepage":"https://envstat.sellorm.com","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sellorm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2022-01-27T22:37:38.000Z","updated_at":"2022-06-11T20:31:11.000Z","dependencies_parsed_at":"2022-09-04T10:22:28.469Z","dependency_job_id":"34d1084a-1a64-4e85-aed7-d5f5de2334d5","html_url":"https://github.com/sellorm/envstat","commit_stats":{"total_commits":56,"total_committers":1,"mean_commits":56.0,"dds":0.0,"last_synced_commit":"5a62a8a26bbfddb3eab827c7af13e989317d0a6d"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sellorm%2Fenvstat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sellorm%2Fenvstat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sellorm%2Fenvstat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sellorm%2Fenvstat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sellorm","download_url":"https://codeload.github.com/sellorm/envstat/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250120104,"owners_count":21378136,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["r","rpackage","rstats","rstats-package"],"created_at":"2024-08-13T07:05:15.958Z","updated_at":"2025-04-21T19:32:40.947Z","avatar_url":"https://github.com/sellorm.png","language":"R","funding_links":[],"categories":["R"],"sub_categories":[],"readme":"\n# envstat\n\n\u003c!-- badges: start --\u003e\n[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)\n[![R-CMD-check](https://github.com/sellorm/envstat/workflows/R-CMD-check/badge.svg)](https://github.com/sellorm/envstat/actions)\n[![Codecov test coverage](https://codecov.io/gh/sellorm/envstat/branch/main/graph/badge.svg)](https://app.codecov.io/gh/sellorm/envstat?branch=main)\n\u003c!-- badges: end --\u003e\n\nChecks your compute **environment status**.\n\nIf you need to know about your R session, you use `sessionInfo()`.\nBut what if you need information on your external environment?\nThings like whether files or directories that you expect exist,\nor that specific environment variables are set. \nThe `envstat` package provides a way to report on your external\ncompute environment, or environment status, outside of R.\n\nUsing a simple YAML configuration file,\n`envstat` can report on the availability of the following:\n\n* Files\n* Directories\n* Environment variables\n* RStudio Package Manager Instances\n* RStudio Connect Instances\n* CRAN repo availability\n\n## Uses\n\nIn today's multi-location working environments, users need to know that\nthe things they require to get their work done are available.\n\nImagine if you often work from home as well as the office and need a VPN to\nin order to use RStudio Connect and Package Manager. The `envstat` \npackage can tell you whether you have access to the things you need to \nbe productive.\n\nMaybe it's a shared directory, or an environment variable.\n`envstat` can help by providing a simple, single-function report that\ntells you what you need to know.\n\n## Installation\n\nInstall from CRAN with:\n\n``` r\ninstall.packages(\"envstat\")\n```\n\nYou can install the development version of envstat like so:\n\n``` r\nremotes::install_github(\"sellorm/envstat\")\n```\n\n## Example\n\nOnce installed you can use `envstat::sitrep()` to produce a pretty\nsituation report:\n\n```\n── envstat situation report ───────────────────────────────────────────\n\n── Checking files ──\n\n✓ Found file: ~/tmp/delete_me\n\n── Checking directories ──\n\n✓ Found directory: ~/tmp\n\n── Checking environment variables ──\n\n✓ Env var set: CONNECT_API_KEY\n\n── Checking RStudio Package Manager instances ──\n\n✓ RSPM instance available: https://rstudio.example.com/rspm\n\n── Checking RStudio Connect instances ──\n\n✓ RSConnect instance available: https://rstudio.example.com/rsc\n✓ RSConnect instance available: https://connect.megacorp.com\n\n── Checking configured repos are available ──\n\n✓ CRAN repo availabe: https://cran.rstudio.com/\n\n── Final result ──\n\n✓ All checks passed!\n```\n\n## config file format\n\nThe config file needs to live in the root of your home directory\nand should be called `.envstat`.\n\nHere is an example that covers all of the currently supported options;\n\nYou can create a example config file in the correct location with\n`envstat::use_envstat()`.\nNaturally, this example config file will result in errors if you run\n`sitrep()` with it as-is, but it's a good example of what's possible.\n\nIn the RStudio IDE, you can edit your envstat config file with \n`envstat::edit_envstat()`.\n\nFeel free to omit any sections you don't need.\n\n```\nfile_exists:\n  - /path/to/myfile\n  - /path/to/a/different/file\ndir_exists:\n  - /path/to/mydir\nrepos_available: TRUE\nRSPM:\n  - https://rstudio.example.com/rspm\nRSConnect:\n  - https://rstudio.example.com/rsc\n  - https://connect.megacorp.com\nenv_vars:\n  - CONNECT_API_KEY\n  - http_proxy\n```\n\n## Config file options\n\n### file_exists\n\nTakes a list of file paths.\n\nTests whether the specified file exists. This can be useful for\nchecking that you have access to a specific filesystem (for example\na Windows share) by checking for a specific file on it. Alternatively, you could\nuse it to check for a specific config file that you use regularly.\n\n### dir_exists\n\nTakes a list of directory paths.\n\nThe same as `file_exists`, but for directories.\n\n### repos_available\n\nBoolean (true/false)\n\nIf this option is set to `true`, envstat will loop through all of the\nrepositories you have configured in `options(\"repos\")` and check if\nthey're available.\n\n### RSPM\n\nList of RStudio Package Manager URLs. Use the base URL of the Package\nManager instance\n\nChecks to see if we can connect to the specified RSPM instances.\n\n### RSConnect\n\nList of RStudio Connect URLs. Use the base URL of the Connect instance.\n\nChecks to see if we can connect to the specified Connect instances.\n\n### env_vars\n\nList of environment variables to check.\n\nUse this section to list any environment variables that you need\nto have set. When run, `envstat::sitrep()` will check if the \nenvironment variables are set and let you know if they're not.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsellorm%2Fenvstat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsellorm%2Fenvstat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsellorm%2Fenvstat/lists"}