Collate 'repometrics' data for a local R package.

This forms part of the data collated by the main repometrics_data function, along with detailed data on individual contributors extracted by the repometrics_data_user function.

Usage

repometrics_data_repo(path, step_days = 1L, num_cores = -1L)

Arguments

path

Path to local repository containing an R package.

step_days

Analyse package at intervals of this number of days. The last commit for each day is chosen. For example, step_days = 7L will return weekly statistics. Values of zero or less will analyse all commits, including potentially multiple daily commits.

num_cores

Number of cores to use in multi-core processing. Has no effect on Windows operating systems, on which calculations are always single-core only. Negative values are subtracted from number of available cores, determined as parallel::detectCores(), so default of num_cores = -1L uses detectCores() - 1L. Positive values use precisely that number, restricted to maximum available cores, and a value of zero will use all available cores.

Value

A list with two main items:

1. "pkgstats" Containing summary data from apply pkgstats routines across the git history of the repository.

2. "cm" Containing data used to derive "CHAOSS metrics", primarily from GitHub data.

See also

Other data: repo_pkgstats_history(), repometrics_data(), repometrics_data_user()