Diagnose Unexplained Acronyms in DESCRIPTION

Flags an acronym in Description that is never spelled out. A parenthetical gloss in either order counts as explained.

Usage

lab_acronyms(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

The CRAN Cookbook covers this under Explaining Acronyms. Reviewers ask for an acronym to be spelled out once, but nothing enforces it, which is why this sits at opinion tier. 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_acronyms(pkg, verbose = FALSE)$passed
#> [1] TRUE