Skip to content

Commit dbb5b2b

Browse files
committed
rename 'rm_data_user' -> 'repometrics_user_data'
1 parent 99a5743 commit dbb5b2b

9 files changed

+47
-81
lines changed

DESCRIPTION

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Package: repometrics
22
Title: Metrics for Your Code Repository
3-
Version: 0.1.3.004
3+
Version: 0.1.3.005
44
Authors@R:
55
person("Mark", "Padgham", , "mark.padgham@email.com", role = c("aut", "cre"),
66
comment = c(ORCID = "0000-0003-2172-5265"))

NAMESPACE

+1-2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,5 @@
33
export(repo_pkgstats_history)
44
export(repometrics_dashboard)
55
export(repometrics_pkg_data)
6-
export(rm_data_repo)
7-
export(rm_data_user)
6+
export(repometrics_user_data)
87
importFrom(memoise,memoise)

R/data-repo.R

+31-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,33 @@
1+
#' Collate 'repometrics' data for a local R package
2+
#'
3+
#' @inheritParams repo_pkgstats_history
4+
#' @return A list with two main items:
5+
#' \enumerate{
6+
#' \item "pkgstats" Containing summary data from apply `pkgstats` routines
7+
#' across the git history of the repository.
8+
#' \item "cm" Containing data used to derive "CHAOSS metrics", primarily from
9+
#' GitHub data.
10+
#' }
11+
#'
12+
#' @export
13+
repometrics_pkg_data <- function (path, step_days = 1L, num_cores = -1L) {
14+
15+
cli::cli_alert_info ("Extracting package statistics ...")
16+
pkgstats <- repo_pkgstats_history (
17+
path,
18+
step_days = step_days,
19+
num_cores = num_cores
20+
)
21+
cli::cli_alert_success ("Done!")
22+
23+
cli::cli_alert_info ("Extracting GitHub data ...")
24+
rm <- rm_data_repo (path)
25+
rm$contributors <- get_all_contribs (rm$contribs_from_log, rm$contribs_from_gh_api)
26+
cli::cli_alert_success ("Done!")
27+
28+
list (pkgstats = pkgstats, rm = rm)
29+
}
30+
131
#' Calculate all repository data used in CHAOSS metrics
232
#' \url{https://chaoss.community/kb-metrics-and-metrics-models/}.
333
#'
@@ -23,7 +53,7 @@
2353
#' \item `repo_from_gh_api` A `data.frame` of a single line, with several key
2454
#' attributes of the repository on GitHub.
2555
#' }
26-
#' @export
56+
#' @noRd
2757
rm_data_repo <- function (path) {
2858

2959
checkmate::assert_directory_exists (path)

R/data-user.R

+4-4
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@
1818
#' \item `issues` with information on all issues opened by user
1919
#' }
2020
#' @export
21-
rm_data_user <- function (login,
22-
ended_at = Sys.time (),
23-
nyears = 1,
24-
n_per_page = 100) {
21+
repometrics_user_data <- function (login,
22+
ended_at = Sys.time (),
23+
nyears = 1,
24+
n_per_page = 100) {
2525

2626
checkmate::assert_character (login, len = 1L)
2727

R/repometrics-data.R

-29
This file was deleted.

codemeta.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"codeRepository": "https://github.com/ropensci-review-tools/repometrics",
99
"issueTracker": "https://github.com/ropensci-review-tools/repometrics/issues",
1010
"license": "https://spdx.org/licenses/GPL-3.0",
11-
"version": "0.1.3.004",
11+
"version": "0.1.3.005",
1212
"programmingLanguage": {
1313
"@type": "ComputerLanguage",
1414
"name": "R",

man/repometrics_pkg_data.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/rm_data_user.Rd man/repometrics_user_data.Rd

+8-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/rm_data_repo.Rd

-39
This file was deleted.

0 commit comments

Comments
 (0)