Runs diagnostics against the package DESCRIPTION file. Fields are parsed
with base::read.dcf() so that multi-line fields like Description and
Title are inspected in full, not just their first physical line.
Value
List containing one named element per check. Each element is a list with at
least passed, issues, and message (see checktor_check_result()).
When the DESCRIPTION is missing or R cannot read it, description_file
fails, and every check that reads the parsed fields, registered ones
included, is reported as skipped with the reason "DESCRIPTION could not be
read", since it has nothing to examine.
See also
checktor() for complete package diagnostics
Examples
pkg_path <- example_diagnose_scenario("description_examples/bad_description.txt",
show_content = FALSE)
results <- diagnose_description_issues(pkg_path, verbose = FALSE)
issues(results) # description-field problems, if any
#> check severity file line
#> 1 software_names policy <NA> NA
#> 2 acronyms opinion <NA> NA
#> 3 license policy <NA> NA
#> 4 title_case policy <NA> NA
#> 5 authors policy <NA> NA
#> 6 description_starts_with policy <NA> NA
#> location
#> 1 Description: ggplot2 should be in single quotes
#> 2 ML
#> 3 License points at a LICENSE file that does not exist
#> 4 Title is not in title case. R would write it as: Example Package for Data Analysis
#> 5 Missing Authors@R field
#> 6 Description should not start with "This package"; describe what it does instead
#> message
#> 1 Software names check
#> 2 Acronyms check
#> 3 License check
#> 4 Title case check
#> 5 Authors@R field check
#> 6 Description opening check