Package Reference

Create Package Reference for Each Package Risk Metric and Cache Metadata

pkg_ref()

Create a package reference

Package Assessment

Assess Package Metadata against a risk criterion

pkg_assess()

Apply assess_* family of functions to a package reference

all_assessments()

A default list of assessments to perform for each package

assess_covr_coverage()

Assess a package code coverage using the `covr` package

assess_downloads_1yr()

Assess a package for the number of downloads in the past year

assess_export_help()

Assess a package for availability of documentation for exported values

assess_has_bug_reports_url()

Assess a package for the presence of a url field where bugs can be reported.

assess_has_maintainer()

Assess a package for an associated maintainer

assess_has_news()

Assess a package for the presence of a NEWS file

assess_has_source_control()

Assess a package for an associated source control url

assess_has_vignettes()

Assess a package for the presence of Vignettes files

assess_has_website()

Assess a package for an associated website url

assess_last_30_bugs_status()

Assess how many recent BugReports have been closed

assess_license()

Assess a package for an acceptable license

assess_news_current()

Assess a package for an up-to-date NEWS file

assess_r_cmd_check()

Assess a package's results from running R CMD check

assess_remote_checks()

Assess package checks from CRAN/Bioc or R CMD check

assessment_error_as_warning()

Error handler for assessments to deescalate errors to warnings

assessment_error_empty()

Error handler for assessments with safe fallback

assessment_error_throw()

Error handler for assessments to throw error immediately

Package Risk Score

Provide Risk Score based on Risk Metrics

pkg_score()

Score a package assessment, collapsing results into a single numeric

pkg_metric()

A helper for structuring assessment return objects for dispatch with the score function

metric_score()

Score a package metric

metric_score(<pkg_metric_covr_coverage>)

Score a package for unit test coverage

metric_score(<pkg_metric_downloads_1yr>)

Defining an Assessment Scoring Function

metric_score(<pkg_metric_export_help>)

Score a package for availability of documentation for exported values

metric_score(<pkg_metric_has_bug_reports_url>)

Score a package for the presence of a bug report url

metric_score(<pkg_metric_has_maintainer>)

Score a package for inclusion of an associated maintainer

metric_score(<pkg_metric_has_news>)

Score a package for the presence of a NEWS file

metric_score(<pkg_metric_has_source_control>)

Score a package for inclusion of an associated source control url

metric_score(<pkg_metric_has_vignettes>)

Score a package for the presence of a Vignettes file

metric_score(<pkg_metric_has_website>)

Score a package for inclusion of an associated website url

metric_score(<pkg_metric_last_30_bugs_status>)

Score a package for number of recently opened BugReports that are now closed

metric_score(<pkg_metric_license>)

Score a package for acceptable license

metric_score(<pkg_metric_news_current>)

Score a package for NEWS files updated to current version

metric_score(<pkg_metric_r_cmd_check>)

Score a package based on R CMD check results run locally

metric_score(<pkg_metric_remote_checks>)

Score a package based on R CMD check results run by BioC or CRAN

Package Risk Summary

Summarizing across metric scores

summarize_scores()

Summarize a default set of assessments into a single risk score

Metric Error Handler

Error handler functions

assessment_error_as_warning()

Error handler for assessments to deescalate errors to warnings

assessment_error_empty()

Error handler for assessments with safe fallback

assessment_error_throw()

Error handler for assessments to throw error immediately

score_error_NA()

Score error handler to silently return NA

score_error_default()

Default score error handling, emitting a warning and returning 0

score_error_zero()

Score error handler to silently return 0

Utilities

Utility functions

as_pkg_metric()

Convert an object to a pkg_metric

as_pkg_ref()

Convert into a package object