Diagnose Title Case in DESCRIPTION

Flags a Title that is not in title case, delegating to tools::toTitleCase(), which restores single-quoted spans so 'shiny' keeps its own capitalisation.

Usage

diagnose_title_case(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_title_case(pkg, verbose = FALSE)$passed
#> [1] TRUE