Package index • validation

Functions for everyday use

check_session() print(<sctovalidity>): Check a sessions loaded packages against the validated packages list

load_pkg_table() load_tests_table(): Load the flat file of validated packages from github

risk_hook(): Hook for collecting user-defined chunk risk level in markdown documents

Functions to aid in package validation

get_12month_downloads(): Get number of downloads in the last 12 months

get_n_deps(): Get the number of dependencies for a package

get_release_date(): Get the release date of a CRAN package

get_pkg_source(): Derive the location of a package's source code

Functions to aid in testing packages

test() print(<validate_result>): Run all tests for a given package

test_skeleton(): Add a new package skeleton

get_tests(): download test files from the validation_tests repo

get_test_data(): Download datasets from the SCTO validation tests repository

Functions primarily for use in GitHub actions

Many functions are only intended to be used in GitHub actions rather than for normal users.

Links to GitHub repositories

These are accessory functions containing the names of the repositories

sctoreports() sctotests() sctopkg(): SCTO repositories

Functions that interface directly with GitHub

gen_pkg_table() gen_tests_table(): Convert issues from to tables

add_label() close_issue() get_comments() get_issue() get_issues() get_test_reports() post_comment() post_issue() remove_label() update_issue(): Interact with the GitHub API to get or set issue information

Functions to work with issue data

calculate_pkg_score(): Convert the text risk metric answers to numeric values and calculate a score

get_valid_pkgs(): Get the list of validated packages from GitHub

is_() is_package() is_test() is_approved() is_triage() get_labels(): Check whether an issue has a particular label

parse_evidence_tab(): Convert test evidence table back to a data frame

update_pkg_table() update_tests_table(): Append new issue data to existing tables

validate_pkg_issue() validate_test_issue(): Validate the inputs for package or function tests

get_tested_pkgs(): Get the list of packages that have tests in a repository

test_to_text(): Convert a test result object to a text string for posting to GitHub