diagnostic_test: Diagnostic testing

In dfeR: Common Department for Education Analysis Tasks

Diagnostic testing

Description

Run a set of diagnostic tests to check for common issues found when setting up R on a DfE system. The function runs each ⁠check_*()⁠ helper in turn and returns a combined list of detected settings. Problems can optionally be fixed by passing clean = TRUE.

The checks include:

• Proxy settings in the Git configuration and system environment (check_proxy_settings())

• Git SSL-verify setting (check_git_sslverify())

• The location of the global .gitconfig file (check_gitconfig_location())

• The GITHUB_PAT system variable (check_github_pat())

• renv download method in .Renviron (check_renv_download_method())

• The RENV_DOWNLOAD_FILE_METHOD system variable (check_renv_dl_file_method())

• Presence of an RTools/make toolchain (check_rtools())

• The location of .Renviron and .Rprofile (check_renv_rprof_location())

Usage

diagnostic_test(clean = FALSE, full = FALSE)

Arguments

clean

If TRUE, attempt to clean detected issues. Default FALSE.

full

If TRUE, append a session-dump section after the per-check output containing renv::diagnostics(), Sys.getenv() and options(). Useful for sharing a full diagnostic with support. Defaults to FALSE. Environment variables whose names look sensitive (containing e.g. TOKEN, SECRET, KEY, PAT, PASSWORD, CRED) are masked, but the options() and renv::diagnostics() sections are printed as-is, so review the output before sharing it in public channels.

Details

Each check returns a list including a status field, one of "pass", "fail", "fixed" or "info", depending on the outcome of the check.

Value

Invisibly, a named list keyed by check (proxy, sslverify, gitconfig, github_pat, renv_download, renv_download_file, rtools, renviron_rprofile). Each entry is the result list returned by the corresponding ⁠check_*⁠ helper, plus a status field.

Examples

diagnostic_test()

dfeR documentation built on Sept. 24, 2026, 1:07 a.m.