dfe-analytical-services / dfeR

Common R tasks in the Department for Education (DfE)
https://dfe-analytical-services.github.io/dfeR/
GNU General Public License v3.0
8 stars 2 forks source link

Add a dfe-specific diagnostics function #63

Open cjrace opened 5 months ago

cjrace commented 5 months ago

Is your feature request related to a problem? Please describe. It's fairly common for our team to need to check through certain environment variables that are known to cause issues on DfE machines while helping teams to diagnose and fix issues.

Describe the solution you'd like A diagnostics function that prints out common variables such as the following list to the console:

I'm sure there'll be more to add to this to. Including does RTools exist, can it be found, and what's the location of key files such as the .Renviron and .Rprofile.

We could also add a verbosity argument, which if = full or true or something, returns full lists such as:

Describe alternatives you've considered Combining this with a clear all / unset all function, might be worth it.

Additional context In the documentation (and console output) we should include the warning that some of the data printed may be sensitive, e.g. GitHub PATs, and not to share them more widely.