Diagnose the Description Opening — diagnose_description_starts_with • checktor

Flags a Description opening with a phrase CRAN forbids ("This package..."), or one that does not begin with a capital letter.

Usage

diagnose_description_starts_with(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.

See also

checktor(), which runs this and every other check.

Examples

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