Skip to contents

repometrics

Metrics for your code repository. A single function collates a wealth of data from commit histories and GitHub interactions, converts it all to standardised metrics, and displays the result as a single, interactive dashboard of your repository.

How?

Installation

First, install the package either via r-universe:

options (repos = c (
    ropenscireviewtools = "https://ropensci-review-tools.r-universe.dev",
    CRAN = "https://cloud.r-project.org"
))
install.packages ("repometrics")

or directly from GitHub with one of these two lines:

remotes::install_github ("ropensci-review-tools/repometrics")
pak::pkg_install ("ropensci-review-tools/repometrics")

Use

The repometrics package has one main function for collating all data for a repository: repometrics_data(). This function has one main parameter, specifying the path to a local directory containing an R package.

data <- repometrics_data (path)

A repometrics dashboard for the repository can then be launched by passing those data to the repometrics_dashboard() function:

The dashboard will automatically open in your default browser.

Prior Art

There are lots of tools for collating metrics of software repositories, most of which are commercial and not open source. Notable open source tools include those in the github.com/chaoss organization, especially their augur and grimoirelab tools. Both of these tools are huge and comprehensive. Although intended to be highly configurable and customizable, they can be difficult both to set up and to use. The OpenSSF Scorecard is a lightweight system focussed on metrics of “security health”.

Plus a host of semi-private and commercial offerings like codescene, SonarQube, SonarGraph, Teamscale, and Understand.

Code of Conduct

Please note that this package is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.