Diagnose a Missing NEWS File — lab_news

CRAN expects packages (especially on resubmission) to document user-facing changes in a NEWS file. Accepts NEWS.md, NEWS, or NEWS.Rd at the package root or under inst/.

Usage

lab_news_file(path, verbose = TRUE)

Arguments

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

Value

checktor_check_result() with passed, issues, message.

Source

No formal rule. A NEWS file is expected but not required, a convention which is why this sits at opinion tier. See vignette("check-sources", package = "checktor") for how every check maps to its source.

Examples

pkg_path <- example_diagnose_scenario("code_examples/tf_usage_bad.R",
                                      show_content = FALSE)
file.remove(file.path(pkg_path, "NEWS.md"))   # demonstrate the failing case
#> [1] TRUE
issues(lab_news_file(pkg_path, verbose = FALSE))
#>   file line                                                         location
#> 1 <NA>   NA No NEWS file found (add NEWS.md to document user-facing changes)
#>           message
#> 1 NEWS file check