Package index • checktor

Overview

Start here. The package-level help topic summarises what checktor checks and how the pieces fit together.

checktor-package: checktor: Extra CRAN Submission Checks

Top-level orchestrator

Functions you call directly to diagnose a package.

checktor(): Diagnose Package for CRAN Submission Issues
checkup(): Quick Health Check
prescribe(): Treatment Recommendations
health_report(): Comprehensive Health Report
configure_doctor(): Configure Package Doctor Defaults

Code-pattern diagnostics

Per-check entry points for R source patterns. Each operates on the parsed AST and can be called independently of checktor().

diagnose_code_issues(): Diagnose Code Health Issues
diagnose_tf_usage(): Diagnose T/F Usage in R Code
diagnose_seed_setting(): Diagnose Hardcoded Seed Setting
diagnose_print_cat_usage(): Diagnose Print/Cat Usage in Functions

DESCRIPTION-field diagnostics

Checks against the DESCRIPTION file, parsed via base::read.dcf().

diagnose_description_issues(): Diagnose DESCRIPTION File Issues

Documentation diagnostics

Checks against .Rd files, walked via tools::parse_Rd().

diagnose_documentation_issues(): Diagnose Documentation Issues
diagnose_value_tags(): Diagnose Missing Value Tags in Documentation
diagnose_missing_examples(): Diagnose Exported Functions Missing Examples
diagnose_roxygen_usage(): Diagnose Roxygen2 Usage
diagnose_example_structure(): Diagnose Example Structure
diagnose_suggested_in_examples(): Diagnose Suggested Packages Used in Examples Without a Guard

General-purpose diagnostics

Package-level checks (size, URLs, NEWS, README links) that don’t fit other categories.

diagnose_general_issues(): Diagnose General Package Issues
diagnose_package_size(): Diagnose Package Size
diagnose_urls(): Diagnose URL Issues in Package Files
diagnose_news_file(): Diagnose a Missing NEWS File
diagnose_readme_relative_links(): Diagnose Relative Links in the README
diagnose_cran_comments_file(): Diagnose a Missing cran-comments.md File

CRAN policy diagnostics

Checks targeting common CRAN policy violations (debugging leftovers, raw shell calls, file/network access).

diagnose_policy_violations(): Check for Common CRAN Policy Violations

Result classes

S3 constructors and print methods for diagnostic result objects. You typically don’t construct these by hand - use the diagnostic functions instead.

checktor_check_result(): Create a Standard Diagnostic Check Result Object
checktor_category_result(): Create a Multi-Category Diagnostic Result Object
print(<checktor_check_result>): Print Method for checktor_check_result Objects
print(<checktor_category_result>): Print Method for checktor_category_result Objects
print(<checktor_results>): Print Method for checktor_results Objects

Result accessors

Plain accessors over diagnostic results so you never navigate nested sublists. Work on a full checktor() result, a single category, or a single check.

issues(): Extract issues, checks, or a per-category summary from checktor results
tidy(<checktor_results>) tidy(<checktor_category_result>) as.data.frame(<checktor_results>) as.data.frame(<checktor_category_result>): Tidy a checktor result into a per-check data frame
summary(<checktor_category_result>) summary(<checktor_results>): Per-category summary of checktor results
passed() is_healthy() n_issues() n_failed_checks() failed_checks(): Status predicates for checktor results
reexports tidy: Objects exported from other packages

Example scenarios

Helpers for building temporary packages with canned bad-pattern code, used in the @examples of individual diagnostics.

example_diagnose_scenario(): Create Example Diagnostic Scenario
show_example_files(): Show Available Example Files