Diagnose a Missing cran-comments.md File — lab_cran_comments

A cran-comments.md file carries the submission notes CRAN reviewers read (test environments, R CMD check results, downstream-dependency notes). Its absence is flagged so it can be added before submission.

Usage

lab_cran_comments_file(path = ".", verbose = TRUE)

Arguments

path: Character. Path to package directory
verbose: Logical. Print diagnostic messages

Value

checktor_check_result() with passed, issues, message.

Details

This check is opt-in: it is not part of the default checktor() / diagnose_general_issues() run, because a cran-comments.md is a workflow convention rather than a CRAN requirement. Call it directly to use it.

Source

No formal rule. A cran-comments.md is a submission-workflow convention rather than a CRAN requirement, which is why this check is opt-in and not part of a default run. 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)
invisible(file.remove(file.path(pkg, "cran-comments.md")))
lab_cran_comments_file(pkg, verbose = FALSE)$issues
#> [1] "No cran-comments.md file with submission notes"
unlink(pkg, recursive = TRUE)