Man pages for riskmetric
Risk Metrics to Evaluating R Packages

all_assessmentsA default list of assessments to perform for each package
allow_mutationa wrapper to assert that a pkg_ref has been permitted to do...
as_pkg_metricConvert an object to a 'pkg_metric'
as_pkg_metric_conditionA pkg_metric subclass for general metric evaluation...
as_pkg_metric_errorA subclass wrapping an error with an additional parent class
as_pkg_metric_naA pkg_metric subclass for when metrics are explicitly not...
as_pkg_metric_todoA pkg_metric subclass for when pkg_metrics have not yet been...
assess_covr_coverageAssess a package code coverage using the 'covr' package
assess_dependenciesAssessment of dependency footprint for a specific package
assess_downloads_1yrAssess a package for the number of downloads in the past year
assess_exported_namespaceAssess a package's results from running R CMD check
assess_export_helpAssess a package for availability of documentation for...
assess_has_bug_reports_urlAssess a package for the presence of a url field where bugs...
assess_has_examplesAssess a package for the presence of example or usage fields...
assess_has_maintainerAssess a package for an associated maintainer
assess_has_newsAssess a package for the presence of a NEWS file
assess_has_source_controlAssess a package for an associated source control url
assess_has_vignettesAssess a package for the presence of Vignettes files
assess_has_websiteAssess a package for an associated website url
assess_last_30_bugs_statusAssess how many recent BugReports have been closed
assess_licenseAssess a package for an acceptable license
assessment_error_as_warningError handler for assessments to deescalate errors to...
assessment_error_emptyError handler for assessments with safe fallback
assessment_error_throwError handler for assessments to throw error immediately
assess_news_currentAssess a package for an up-to-date NEWS file
assess_r_cmd_checkAssess a package's results from running R CMD check
assess_remote_checksAssess package checks from CRAN/Bioc or R CMD check
assess_reverse_dependenciesGenerate list of Reverse Dependencies for a package
assess_size_codebaseAssess a package for size of code base
available_pkg_ref_fieldsA helper function for retrieving a list of available fields,...
bare_envevaluate an expression with a pkg_ref object reclassed as a...
bug_report_metadataHelper for structuring bug reports
cache_behaviorsList of available caching behaviors with metadata, including...
capture_expr_outputCapture side effects issued by an evaluated expression
dec_mutations_countdecrement the number of allowed mutations
determine_pkg_sourceDetermine the intended source of a new package
dot-toolsAccessor for tools namespace
examples_from_dirBuild logical vector for Rd objects with example or usage...
examples_from_pkgBuild logical vector for Rd objects with example or usage...
filter_rd_dbFilter a simple database of Rd objects in a package for files...
firstS3methodFind the S3 method that will be evaluated when an S3 generic...
format_assessment_messageAssessment console printing formatter
get_assessment_columnsHelper for retrieving a list of columns which contain...
get_assessmentsGet a specific set of assess_* functions for pkg_assess
get_package_dependenciesGets available packages from necessary repository and filters...
get_pkg_ref_classesWalk the pkg_ref class hierarchy to match a single subclass...
if_not_null_elseIf not NULL else
inc_mutations_countincrement the number of allowed mutations
is_url_subpath_ofcheck if a url originates from a list of repo urls
memoise_bioc_mirrorsFetch BioC Mirrors Info
memoise_cran_mirrorsFetch CRAN Mirrors Info
metric_scoreScore a package metric
metric_score.pkg_metric_covr_coverageScore a package for unit test coverage
metric_score.pkg_metric_dependenciesScore a package for dependencies
metric_score.pkg_metric_downloads_1yrDefining an Assessment Scoring Function
metric_score.pkg_metric_exported_namespaceScore a package for the number of exported objects
metric_score.pkg_metric_export_helpScore a package for availability of documentation for...
metric_score.pkg_metric_has_bug_reports_urlScore a package for the presence of a bug report url
metric_score.pkg_metric_has_examplesScore a package for the presence of a example or usage fields
metric_score.pkg_metric_has_maintainerScore a package for inclusion of an associated maintainer
metric_score.pkg_metric_has_newsScore a package for the presence of a NEWS file
metric_score.pkg_metric_has_source_controlScore a package for inclusion of an associated source control...
metric_score.pkg_metric_has_vignettesScore a package for the presence of a Vignettes file
metric_score.pkg_metric_has_websiteScore a package for inclusion of an associated website url
metric_score.pkg_metric_last_30_bugs_statusScore a package for number of recently opened BugReports that...
metric_score.pkg_metric_licenseScore a package for acceptable license
metric_score.pkg_metric_news_currentScore a package for NEWS files updated to current version
metric_score.pkg_metric_r_cmd_checkScore a package based on R CMD check results run locally
metric_score.pkg_metric_remote_checksScore a package based on R CMD check results run by BioC or...
metric_score.pkg_metric_reverse_dependenciesScoring method for number of reverse dependencies a package...
metric_score.pkg_metric_size_codebaseScore a package for number of lines of code
news_from_dirBuild a list of NEWS files discovered within a given...
parse_dcf_dependenciesParse DCF of description file
pkg_assessApply assess_* family of functions to a package reference
pkg_metricA helper for structuring assessment return objects for...
pkg_metric_evalEvaluate a metric
pkg_refCreate a package reference
pkg_ref_cache.bug_reports_host.defaultGet the host name of a BugReports url
pkg_ref_cache.bug_reports_url.pkg_sourceGet the BugReports url
pkg_ref_cache.covr_coverage.pkg_sourceRetrieve output of covr::package_coverage
pkg_ref_cache.expression_coverage.pkg_sourceRetrieve output of covr::package_coverage, tallied by...
pkg_ref_cache.help.pkg_installCache a list of available help files as LaTeX objects
pkg_ref_cache.help.pkg_sourceCache a list of available help files as LaTeX objects
pkg_ref_cache.news.pkg_remoteCache a list of NEWS files from a package reference
pkg_ref_class_hierarchyThe 'pkg_ref' subclass hierarchy, used for pkg_ref object...
pkg_ref_mutability_errorpretty printing for a pkg_ref mutability error caused by...
pkg_scoreScore a package assessment, collapsing results into a single...
print.with_eval_recordingHandle pretty printing of expression output
remove_base_packagesHelper function to remove base and recommended packages
require_cache_behaviorsStop if a function requires disabled behaviors
riskmetricriskmetric
riskmetric_metadata_cachingS3 generic to calculate a 'pkg_ref' field
roxygen_assess_familyHelper for creating a roxygen header from template for...
roxygen_assess_family_catalogHelper for creating a roxygen itemized list for assess_*...
roxygen_cache_behaviorsDocument both declare_cache_behavior parameters and options...
roxygen_score_familyHelper for creating a roxygen header from template for...
score_error_defaultDefault score error handling, emitting a warning and...
score_error_NAScore error handler to silently return NA
score_error_zeroScore error handler to silently return 0
sub-sub-.pkg_refLazily instantiated, immutable metadata access
summarize_scoresSummarize a default set of assessments into a single risk...
suppressMatchingConditionsSuppress messages and warnings based on one or more regex...
use_assessments_column_namesreassign assignment list names with column_name attribute if...
verify_pkg_sourceVerify a pkg_source when one is manually specified by the...
vignettes_from_dirBuild a List of Vignettes Files Discovered Within a Given...
vignettes_from_htmlBuild a List of Vignettes Files Discovered Within a Package...
with.pkg_refEvaluate an expression in the context of a pkg_ref
with_unclassed_toEvaluate an expression after first removing a range of S3...
riskmetric documentation built on May 29, 2024, 7:13 a.m.