Diagnose Unquoted Software Names in DESCRIPTION — lab_software_names • checktor

Flags a package or external-software name in Title/Description that is not in single quotes, as Writing R Extensions requires.

Usage

lab_software_names(path = ".", verbose = TRUE, desc = NULL)

Arguments

path: Character. Path to the package directory. Default: ".".
verbose: Logical. Print diagnostic output. Default: TRUE.
desc: Optional pre-parsed DESCRIPTION, as returned by base::read.dcf(). Defaults to reading it from path.

Value

checktor_check_result() with passed, issues, message.

Source

Writing R Extensions, under "The DESCRIPTION file", asks you to "Refer to other packages and external software in single quotes". 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_software_names(pkg, verbose = FALSE)$passed
#> [1] TRUE