Diagnose Reference Formatting in DESCRIPTION — lab_references • checktor

Flags a reference that is not in CRAN's expected <doi:...> / <arXiv:...> form.

Usage

lab_references(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 incoming check run by R CMD check --as-cran NOTEs a reference not written in the <doi:...> or <arXiv:...> form. 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_references(pkg, verbose = FALSE)$passed
#> [1] TRUE