Skip to contents

Diagnose Writes to the Global Environment

Source: R/diagnostics-code-state.R
lab_globalenv_mod.Rd

Flags a <<- whose target binds in neither an enclosing function nor the package, and so reaches .GlobalEnv. A closure updating its parent, or a package-level cache, is not flagged.

Usage

lab_globalenv_mod(path = ".", verbose = TRUE, parsed = NULL)

Arguments

path

Character. Path to the package directory. Default: ".".

verbose

Logical. Print diagnostic output. Default: TRUE.

parsed

Optional pre-parsed source, as returned internally by the orchestrator. Defaults to parsing path afresh.

Value

checktor_check_result() with passed, issues, message.

Source

The CRAN Repository Policy states that "Packages should not modify the global environment (user's workspace)." See vignette("check-sources", package = "checktor") for how every check maps to its source.

See also

checktor(), which runs this and every other check.

Examples

pkg <- example_diagnose_scenario("code_examples/globalenv_bad.R",
                                 show_content = FALSE)
lab_globalenv_mod(pkg, verbose = FALSE)$issues
#> [1] "globalenv_bad.R:5 (GLOBAL_CONFIG)" "globalenv_bad.R:18 (COUNTER)"     
#> [3] "globalenv_bad.R:20 (COUNTER)"     
unlink(pkg, recursive = TRUE)