Extra CRAN Submission Checks

Documentation for package ‘checktor’ version 0.2.0

Help Pages

-- A --

as.data.frame.checktor_category_result	Tidy a checktor result into a per-check data frame
as.data.frame.checktor_results	Tidy a checktor result into a per-check data frame

-- C --

checktor	Diagnose Package for CRAN Submission Issues
checktor_category_result	Create a Multi-Category Diagnostic Result Object
checktor_check_result	Create a Standard Diagnostic Check Result Object
checkup	Quick Health Check
ci_report	Report Findings in the Format Your CI Understands
collect_rd_text	Flatten a Parsed '.Rd' Node to Text
configure_doctor	Configure Package Doctor Defaults

-- D --

diagnose_code_issues	Diagnose Code Health Issues
diagnose_description_issues	Diagnose DESCRIPTION File Issues
diagnose_documentation_issues	Diagnose Documentation Issues
diagnose_general_issues	Diagnose General Package Issues
diagnose_policy_violations	Check for Common CRAN Policy Violations

-- E --

example_diagnose_scenario	Create Example Diagnostic Scenario
extract_rd_section	Extract One Section from a Parsed '.Rd' File

-- F --

failed_checks	Status predicates for checktor results
failed_checks.checktor_category_result	Status predicates for checktor results
failed_checks.checktor_results	Status predicates for checktor results
find_package_root	Find the Root of the Package Containing a Path

-- H --

health_report

Comprehensive Health Report

-- I --

issues	Extract issues, checks, or a per-category summary from checktor results
issues.checktor_category_result	Extract issues, checks, or a per-category summary from checktor results
issues.checktor_check_result	Extract issues, checks, or a per-category summary from checktor results
issues.checktor_results	Extract issues, checks, or a per-category summary from checktor results
is_healthy	Status predicates for checktor results
is_healthy.checktor_category_result	Status predicates for checktor results
is_healthy.checktor_check_result	Status predicates for checktor results
is_healthy.checktor_results	Status predicates for checktor results

-- L --

lab_acronyms	Diagnose Unexplained Acronyms in DESCRIPTION
lab_authors	Diagnose the Authors@R Field
lab_browser_calls	Diagnose Leftover browser() Calls
lab_citation_file	Diagnose Old-Style or Unsafe Calls in inst/CITATION
lab_code_exercised	Diagnose a Package Nothing Exercises
lab_commented_examples	Diagnose Examples That Run Nothing
lab_core_usage	Diagnose Parallel Core Usage
lab_cph_role	Diagnose a Missing Copyright Holder
lab_cran_comments_file	Diagnose a Missing cran-comments.md File
lab_date_format	Diagnose the DESCRIPTION Date Field
lab_description_fields	Diagnose DESCRIPTION Fields R Does Not Know
lab_description_file	Diagnose a DESCRIPTION File R Cannot Read
lab_description_function_quotes	Diagnose Single-Quoted Function Names
lab_description_length	Diagnose Description Length
lab_description_placeholders	Diagnose Template Text Left in DESCRIPTION
lab_description_quoted_quotes	Diagnose Double-Quoted Software Names
lab_description_starts_with	Diagnose the Description Opening
lab_detect_cores_robustness	Diagnose Unguarded 'detectCores()'
lab_donttest_vs_dontrun	Diagnose dontrun Where donttest Belongs
lab_encoding_utf8	Diagnose a DESCRIPTION Encoding Other Than UTF-8
lab_example_installs	Diagnose Installs in Examples, Vignettes and Demos
lab_example_interactive	Diagnose Interactive Examples Hidden in \\dontrun{} or \\donttest{}
lab_example_internal_ns	Diagnose ':::' in Examples
lab_example_state	Diagnose Session State Left Changed by Examples
lab_example_structure	Diagnose Example Structure
lab_example_tf_usage	Diagnose 'T'/'F' Usage in Examples, Vignettes and Demos
lab_example_unparseable	Diagnose Examples That Are Not Valid R
lab_example_writes	Diagnose Writes Outside the Temporary Directory in Examples
lab_file_operations	Diagnose Writes to the User's Filespace
lab_format_names	Diagnose Bare Format and Markup Names in DESCRIPTION
lab_globalenv_mod	Diagnose Writes to the Global Environment
lab_hardcoded_credentials	Diagnose Hardcoded Credentials in Package Code
lab_home_writing	Diagnose Writes to the User's Home Directory
lab_identifier_format	Diagnose Author Identifier Formatting
lab_installed_packages	Diagnose installed.packages() Usage
lab_internal_ns	Diagnose ':::' in Package Code
lab_language_names	Diagnose Programming-Language Names in DESCRIPTION
lab_library_in_pkg	Diagnose library() in Package Code
lab_license	Diagnose the License Field
lab_license_file_unneeded	Diagnose an Unneeded LICENSE File Pointer
lab_license_year	Diagnose an Unfilled LICENSE Template
lab_missing_examples	Diagnose Exported Functions Missing Examples
lab_network_operations	Diagnose Unguarded Network Access
lab_news_file	Diagnose a Missing NEWS File
lab_option_changes	Diagnose Unrestored Option Changes
lab_package_size	Diagnose Package Size
lab_print_cat_usage	Diagnose Print/Cat Usage in Functions
lab_rd_bibliography	Diagnose Citations Missing From the Bibliography
lab_rd_bibliography_files	Diagnose a Bibliography R Cannot Read or Install
lab_readme_links	Diagnose Relative Links in the README
lab_references	Diagnose Reference Formatting in DESCRIPTION
lab_roxygen_usage	Diagnose Stale Generated Documentation
lab_seed_setting	Diagnose Hardcoded Seed Setting
lab_software_install	Diagnose Package Installation From Package Code
lab_software_names	Diagnose Unquoted Software Names in DESCRIPTION
lab_spelling	Diagnose Possibly Misspelled Words in DESCRIPTION
lab_suggested_in_examples	Diagnose Suggested Packages Used in Examples Without a Guard
lab_system_calls	Diagnose System Calls
lab_sys_setenv	Diagnose Unrestored Environment Variables
lab_temp_cleanup	Diagnose Missing Temp-File Cleanup
lab_tf_usage	Diagnose 'T'/'F' Usage in R Code
lab_title_case	Diagnose Title Case in DESCRIPTION
lab_title_length	Diagnose Title Length
lab_title_package_name	Diagnose a Title That Repeats the Package Name
lab_title_redundant_phrases	Diagnose Redundant Phrases in Title
lab_title_starts_with_article	Diagnose Title Starting With an Article
lab_unexported_example_ns	Diagnose Bare Calls to Unexported Functions in Examples
lab_urls	Diagnose URL Issues in Package Files
lab_url_liveness	Diagnose Broken and Redirecting URLs
lab_value_tags	Diagnose Missing Value Tags in Documentation
lab_version_format	Diagnose the DESCRIPTION Version Field
lab_warn_option	Diagnose Changes to options(warn=)

-- N --

not_under_fn_with_call_xpath	XPath Predicate: Not Guarded by a Sibling Call
n_failed_checks	Status predicates for checktor results
n_failed_checks.checktor_category_result	Status predicates for checktor results
n_failed_checks.checktor_results	Status predicates for checktor results
n_issues	Status predicates for checktor results
n_issues.checktor_category_result	Status predicates for checktor results
n_issues.checktor_check_result	Status predicates for checktor results
n_issues.checktor_results	Status predicates for checktor results

-- P --

passed	Status predicates for checktor results
passed.checktor_category_result	Status predicates for checktor results
passed.checktor_check_result	Status predicates for checktor results
passed.checktor_results	Status predicates for checktor results
predicates	Status predicates for checktor results
prescribe	Treatment Recommendations
print.checktor_category_result	Print Method for checktor_category_result Objects
print.checktor_check_result	Print Method for checktor_check_result Objects
print.checktor_results	Print Method for checktor_results Objects

-- R --

read_r_xml	Parse a Package's R Sources into Queryable XML
registered_checks	List Registered Checks
register_check	Register a Custom Check with 'checktor()'

-- S --

show_example_files	Show Available Example Files
summary.checktor_category_result	Per-category summary of checktor results
summary.checktor_results	Per-category summary of checktor results

-- T --

tidy.checktor_category_result	Tidy a checktor result into a per-check data frame
tidy.checktor_results	Tidy a checktor result into a per-check data frame

-- U --

undesirable_function_check	Flag Every Call to a Named Function
unregister_check	Remove Registered Checks

-- X --

xpath_lints	Collect XPath Matches as 'file:line' Strings
xpath_per_file	Summarise XPath Matches per File