Diagnose Title Starting With an Article

Flags a Title beginning with A, An, or The.

Usage

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

No rule. This was a mis-transplant of a real CRAN rule and is kept callable but off by default. 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("description_examples/title_starts_with_article_bad.txt",
                                 show_content = FALSE)
lab_title_starts_with_article(pkg, verbose = FALSE)$issues
#> [1] "Title starts with an article (A/An/The)"
unlink(pkg, recursive = TRUE)