
Apply pkgstats across the git history of a package
Source:R/data-pkgstats.R
repo_pkgstats_history.Rd
Apply pkgstats across the git history of a package
Arguments
- path
Path to local repository containing an R package.
- date_interval
Interval at which to analyse package statistics, with options of "day", "week", "month", or "year". The last commit for each period is chosen.
- 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 ofnum_cores = -1L
usesdetectCores() - 1L
. Positive values use precisely that number, restricted to maximum available cores, and a value of zero will use all available cores.
Value
NULL
if path
is not an R package, or if no pkgstats
results are able to be extracted. Otherwise, a list of three items:
desc_data Containing data from
DESCRIPTION
files, along with data on numbers of functions.loc Containing data on "lines-of-code" for all languages and sub-directories within package.
stats Containing statistics on (mean, medium, and sum) of various properties of each function in package.
See also
Other data:
repometrics_data()
,
repometrics_data_repo()
,
repometrics_data_user()