Skip to contents

Diagnose General Package Issues

Source: R/diagnostics-general.R
diagnose_general_issues.Rd

Runs general diagnostics on package structure and content that don't fit into specific code, documentation, or DESCRIPTION categories.

Usage

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

Arguments

path

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

verbose

Logical. Print diagnostic output. Default: TRUE.

Value

List of checktor_check_result() objects plus a passed summary.

Details

This function checks:

  • Package size — measured against the files that would ship in the tarball (.Rbuildignore and standard scratch dirs are excluded), with a 5 MB warning threshold matching CRAN's recommendation.

  • Invalid or problematic URLs in package files.

  • Presence of a NEWS file documenting user-facing changes.

  • Relative links in the README that would break on CRAN.

diagnose_cran_comments_file() is intentionally not part of this default run, since a cran-comments.md is a workflow convention rather than a CRAN requirement; call it directly to opt in.

See also

checktor() for complete package diagnostics

Examples

pkg_path <- example_diagnose_scenario("code_examples/tf_usage_bad.R",
                                      show_content = FALSE)
general_results <- diagnose_general_issues(pkg_path, verbose = FALSE)
general_results$package_size$size_mb
#> [1] 0.001089096