Diagnose Code Health Issues

Runs comprehensive diagnostics on R source code to identify common CRAN submission issues and coding best-practice violations.

Usage

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

Arguments

path

Character. Path to the R package directory. Default: ".".

verbose

Logical. Whether to print detailed diagnostic output. Default: TRUE.

Value

List of named checktor_check_result() objects (e.g., tf_usage, seed_setting) plus a passed named logical vector summarizing pass/fail for each sub-check.

Details

Each source file is parsed once with parse(keep.source = TRUE); checks run XPath queries against the parsed XML representation, so identifiers that appear only inside string literals or comments do not false-positive. Multi-line constructs (set.seed(\n123\n)), formula ~ versus path ~, and scope-aware patterns (an options() call guarded by a sibling on.exit() in the same function body) are all handled correctly.

See also

checktor() for complete package diagnostics

Examples

pkg <- example_diagnose_scenario("code_examples/tf_usage_bad.R",
                                 show_content = FALSE)
code_results <- diagnose_code_issues(pkg, verbose = FALSE)
summary(code_results)   # per-category overview
#>   checks passed failed issues
#> 1     13     12      1      7
issues(code_results)    # the issues found
#>      check           file line          location         message
#> 1 tf_usage tf_usage_bad.R    8  tf_usage_bad.R:8 T/F usage check
#> 2 tf_usage tf_usage_bad.R   11 tf_usage_bad.R:11 T/F usage check
#> 3 tf_usage tf_usage_bad.R   15 tf_usage_bad.R:15 T/F usage check
#> 4 tf_usage tf_usage_bad.R   18 tf_usage_bad.R:18 T/F usage check
#> 5 tf_usage tf_usage_bad.R   22 tf_usage_bad.R:22 T/F usage check
#> 6 tf_usage tf_usage_bad.R   23 tf_usage_bad.R:23 T/F usage check
#> 7 tf_usage tf_usage_bad.R   26 tf_usage_bad.R:26 T/F usage check