Skip to contents

Diagnose Writes to the User's Filespace

Source: R/diagnostics-policy.R
lab_file_operations.Rd

Flags a write whose destination is a literal path, so it provably lands in the working directory or the user's home. A caller-supplied or computed destination is permission, and is not flagged.

Usage

lab_file_operations(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 ... anywhere ... 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/file_operations_bad.R",
                                 show_content = FALSE)
lab_file_operations(pkg, verbose = FALSE)$issues
#> [1] "file_operations_bad.R:7 (write.csv())"
#> [2] "file_operations_bad.R:13 (cat())"     
unlink(pkg, recursive = TRUE)