Man pages for pharmaR/riskmetric
Risk Metrics to Evaluating R Packages
| all_assessments | A default list of assessments to perform for each package |
| allow_mutation | a wrapper to assert that a pkg_ref has been permitted to do... |
| as_pkg_metric | Convert an object to a 'pkg_metric' |
| as_pkg_metric_condition | A pkg_metric subclass for general metric evaluation... |
| as_pkg_metric_error | A subclass wrapping an error with an additional parent class |
| as_pkg_metric_na | A pkg_metric subclass for when metrics are explicitly not... |
| as_pkg_metric_todo | A pkg_metric subclass for when pkg_metrics have not yet been... |
| assess_covr_coverage | Assess a package code coverage using the 'covr' package |
| assess_dependencies | Assessment of dependency footprint for a specific package |
| assess_downloads_1yr | Assess a package for the number of downloads in the past year |
| assess_exported_namespace | Assess a package's results from running R CMD check |
| assess_export_help | Assess a package for availability of documentation for... |
| assess_has_bug_reports_url | Assess a package for the presence of a url field where bugs... |
| assess_has_examples | Assess a package for the presence of example or usage fields... |
| 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 |
| assessment_error_as_warning | Error handler for assessments to deescalate errors to... |
| assessment_error_empty | Error handler for assessments with safe fallback |
| assessment_error_throw | Error handler for assessments to throw error immediately |
| 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 |
| assess_reverse_dependencies | Generate list of Reverse Dependencies for a package |
| assess_size_codebase | Assess a package for size of code base |
| available_pkg_ref_fields | A helper function for retrieving a list of available fields,... |
| bare_env | evaluate an expression with a pkg_ref object reclassed as a... |
| bug_report_metadata | Helper for structuring bug reports |
| cache_behaviors | List of available caching behaviors with metadata, including... |
| capture_expr_output | Capture side effects issued by an evaluated expression |
| dec_mutations_count | decrement the number of allowed mutations |
| determine_pkg_source | Determine the intended source of a new package |
| dot-tools | Accessor for tools namespace |
| examples_from_dir | Build logical vector for Rd objects with example or usage... |
| examples_from_pkg | Build logical vector for Rd objects with example or usage... |
| filter_rd_db | Filter a simple database of Rd objects in a package for files... |
| firstS3method | Find the S3 method that will be evaluated when an S3 generic... |
| format_assessment_message | Assessment console printing formatter |
| get_assessment_columns | Helper for retrieving a list of columns which contain... |
| get_assessments | Get a specific set of assess_* functions for pkg_assess |
| get_package_dependencies | Gets available packages from necessary repository and filters... |
| get_pkg_ref_classes | Walk the pkg_ref class hierarchy to match a single subclass... |
| if_not_null_else | If not NULL else |
| inc_mutations_count | increment the number of allowed mutations |
| is_url_subpath_of | check if a url originates from a list of repo urls |
| memoise_bioc_mirrors | Fetch BioC Mirrors Info |
| memoise_cran_mirrors | Fetch CRAN Mirrors Info |
| metric_score | Score a package metric |
| metric_score.pkg_metric_covr_coverage | Score a package for unit test coverage |
| metric_score.pkg_metric_dependencies | Score a package for dependencies |
| metric_score.pkg_metric_downloads_1yr | Defining an Assessment Scoring Function |
| metric_score.pkg_metric_exported_namespace | Score a package for the number of exported objects |
| metric_score.pkg_metric_export_help | Score a package for availability of documentation for... |
| metric_score.pkg_metric_has_bug_reports_url | Score a package for the presence of a bug report url |
| metric_score.pkg_metric_has_examples | Score a package for the presence of a example or usage fields |
| 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... |
| 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... |
| 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... |
| metric_score.pkg_metric_reverse_dependencies | Scoring method for number of reverse dependencies a package... |
| metric_score.pkg_metric_size_codebase | Score a package for number of lines of code |
| news_from_dir | Build a list of NEWS files discovered within a given... |
| parse_dcf_dependencies | Parse DCF of description file |
| pkg_assess | Apply assess_* family of functions to a package reference |
| pkg_metric | A helper for structuring assessment return objects for... |
| pkg_metric_eval | Evaluate a metric |
| pkg_ref | Create a package reference |
| pkg_ref_cache.bug_reports_host.default | Get the host name of a BugReports url |
| pkg_ref_cache.bug_reports_url.pkg_source | Get the BugReports url |
| pkg_ref_cache.covr_coverage.pkg_source | Retrieve output of covr::package_coverage |
| pkg_ref_cache.expression_coverage.pkg_source | Retrieve output of covr::package_coverage, tallied by... |
| pkg_ref_cache.help.pkg_install | Cache a list of available help files as LaTeX objects |
| pkg_ref_cache.help.pkg_source | Cache a list of available help files as LaTeX objects |
| pkg_ref_cache.news.pkg_remote | Cache a list of NEWS files from a package reference |
| pkg_ref_class_hierarchy | The 'pkg_ref' subclass hierarchy, used for pkg_ref object... |
| pkg_ref_mutability_error | pretty printing for a pkg_ref mutability error caused by... |
| pkg_score | Score a package assessment, collapsing results into a single... |
| print.with_eval_recording | Handle pretty printing of expression output |
| remove_base_packages | Helper function to remove base and recommended packages |
| require_cache_behaviors | Stop if a function requires disabled behaviors |
| riskmetric | riskmetric |
| riskmetric_metadata_caching | S3 generic to calculate a 'pkg_ref' field |
| roxygen_assess_family | Helper for creating a roxygen header from template for... |
| roxygen_assess_family_catalog | Helper for creating a roxygen itemized list for assess_*... |
| roxygen_cache_behaviors | Document both declare_cache_behavior parameters and options... |
| roxygen_score_family | Helper for creating a roxygen header from template for... |
| score_error_default | Default score error handling, emitting a warning and... |
| score_error_NA | Score error handler to silently return NA |
| score_error_zero | Score error handler to silently return 0 |
| sub-sub-.pkg_ref | Lazily instantiated, immutable metadata access |
| summarize_scores | Summarize a default set of assessments into a single risk... |
| suppressMatchingConditions | Suppress messages and warnings based on one or more regex... |
| use_assessments_column_names | reassign assignment list names with column_name attribute if... |
| verify_pkg_source | Verify a pkg_source when one is manually specified by the... |
| vignettes_from_dir | Build a List of Vignettes Files Discovered Within a Given... |
| vignettes_from_html | Build a List of Vignettes Files Discovered Within a Package... |
| with.pkg_ref | Evaluate an expression in the context of a pkg_ref |
| with_unclassed_to | Evaluate an expression after first removing a range of S3... |
