Diagnose Programming-Language Names in DESCRIPTION

Flags a bare programming-language, markup, or statistical-computing name – Python, Java, C++, SQL, HTML, MATLAB, SAS and more – in Title or Description that CRAN asks to see single-quoted. This is the language counterpart to lab_software_names(): both are policy-tier quoting checks, kept separate because a language name and a package name are different kinds of thing. R itself is never flagged in either form. No authority names it, and a bare R and a quoted 'R' both clear CRAN, so checktor takes no position on which you write. Single-letter or common-word names (C, Go, Swift) are left out because they cannot be told from ordinary prose.

Usage

lab_language_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.

Details

A package can extend the list through Config/checktor/language_names in its own DESCRIPTION.

Source

Writing R Extensions, under "The DESCRIPTION file", asks for single quotes around other software; checktor applies the same to programming-language and markup names. See vignette("check-sources", package = "checktor") for how every check maps to its source.

Examples

pkg <- example_diagnose_scenario("code_examples/tf_usage_bad.R",
                                 show_content = FALSE)
lab_language_names(pkg, verbose = FALSE)$passed
#> [1] TRUE