riskmetric is a collection of risk metrics to evaluate the quality of R
packages.
This package is in experimentation. Final considerations about design are being considered, but core concepts are considered final.
The risk of using an R package is evaluated based on a number of metrics meant to evaluate development best practices, code documentation, community engagement and development sustainability. We hope to provide a framework to quantify risk by assessing these metrics. This package serves as a starting point for exploring the heterogeneity of code quality, and begin a broader conversation about the validation of R packages. Primarily, this effort aims to provide some context for validation within regulated industries.
riskmetric is not yet on CRAN. Until it is, install using devtools.
devtools::install_github("pharmaR/riskmetric")Scrape metadata locally or remotely, then assess that metadata and score it to estimate risk. For each package, derive a composite measure of risk, or a collection of individual scores which can be easily used to generate validation reports.
library(dplyr)
library(riskmetric)
pkg_ref(c("riskmetric", "utils", "tools")) %>%
as_tibble() %>%
assess() %>%
score() %>%
mutate(risk = summarize_risk(.))We had a bi-weekly sprint meeting for developer to discuss the progress.
- Frequecy: every two weeks
- Starting Time: 2019/11/06 12:00 PM - 12:30 PM
- Project Planning Meeting Structure
- Milestone
- Meeting Room
riskmetric is centrally a community project. Comfort with a quantification of
risk comes via consensus, and for that this project is dependent on close
community engagement. There are plenty of ways to help:
- Share the package
- File issues when you encounter bugs
- Weigh in on proposed metrics, or suggest a new one
- Help us devise the best way to summarize risk into a single score
- Help us keep documentation up to date
- Contribute code to tackle the metric backlog