Diagnose Missing Value Tags in Documentation — lab_value

Walks .Rd files via tools::parse_Rd() and reports topics that are missing a \value{} section. Data, class, methods, package-level, and re-export topics are skipped (they don't need \value{}).

Usage

lab_value_tags(path, verbose = TRUE)

Arguments

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

Value

checktor_check_result() with passed, issues, missing, message.

Source

Writing R Extensions, under "Documenting functions", describes \value{}, and the CRAN Cookbook keeps the recipe reviewers cite under Missing value-tags in .Rd-files, but R CMD check does not require it, so checktor keeps this at opinion tier. See vignette("check-sources", package = "checktor") for how every check maps to its source.

Examples

pkg_path <- example_diagnose_scenario("documentation_examples/missing_value_tag.Rd",
                                      show_content = FALSE)
issues(lab_value_tags(pkg_path, verbose = FALSE))
#>   file line             location          message
#> 1 <NA>   NA missing_value_tag.Rd Value tags check