Skip to contents

Diagnose Writes to the User's Home Directory

Source: R/diagnostics-code.R
lab_home_writing.Rd

Flags a write whose destination resolves to ~ or $HOME.

Usage

lab_home_writing(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 write in the user's home filespace ... nor anywhere else on the file system apart from the R session's temporary directory". 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/tf_usage_bad.R",
                                 show_content = FALSE)
lab_home_writing(pkg, verbose = FALSE)$passed
#> [1] TRUE