Merge pull request #56 from ropensci-review-tools/repo-user-data

rename main fns: repometrics_data_pkg/user

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: repometrics
 Title: Metrics for Your Code Repository
-Version: 0.1.3.003
+Version: 0.1.3.006
 Authors@R: 
     person("Mark", "Padgham", , "[email protected]", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0003-2172-5265"))

NAMESPACE

@@ -2,7 +2,6 @@
 
 export(repo_pkgstats_history)
 export(repometrics_dashboard)
-export(repometrics_data)
-export(rm_data_repo)
-export(rm_data_user)
+export(repometrics_data_pkg)
+export(repometrics_data_user)
 importFrom(memoise,memoise)

R/data-dependencies.R

@@ -62,9 +62,12 @@ rm_data_libyears <- function (path) {
     deps <- deps [which (!is.na (deps$published)), ]
 
     rel <- rm_data_releases_from_gh_api (path, latest_only = TRUE)
-    rel_date <- as.Date (strftime (rel$published_at, format = "%Y-%m-%d"))
+    dt <- NA_real_
+    if (nrow (rel) > 0L) {
+        rel_date <- as.Date (strftime (rel$published_at, format = "%Y-%m-%d"))
+        dt <- difftime (deps$published, rel_date, units = "days")
 
-    dt <- difftime (deps$published, rel_date, units = "days")
+    }
     deps$libyears <- as.numeric (dt) / 365.25 # In years
 
     return (deps)

R/data-repo.R

@@ -1,3 +1,33 @@
+#' Collate 'repometrics' data for a local R package
+#'
+#' @inheritParams repo_pkgstats_history
+#' @return A list with two main items:
+#' \enumerate{
+#' \item "pkgstats" Containing summary data from apply `pkgstats` routines
+#' across the git history of the repository.
+#' \item "cm" Containing data used to derive "CHAOSS metrics", primarily from
+#' GitHub data.
+#' }
+#'
+#' @export
+repometrics_data_pkg <- function (path, step_days = 1L, num_cores = -1L) {
+
+    cli::cli_alert_info ("Extracting package statistics ...")
+    pkgstats <- repo_pkgstats_history (
+        path,
+        step_days = step_days,
+        num_cores = num_cores
+    )
+    cli::cli_alert_success ("Done!")
+
+    cli::cli_alert_info ("Extracting GitHub data ...")
+    rm <- rm_data_repo (path)
+    rm$contributors <- get_all_contribs (rm$contribs_from_log, rm$contribs_from_gh_api)
+    cli::cli_alert_success ("Done!")
+
+    list (pkgstats = pkgstats, rm = rm)
+}
+
 #' Calculate all repository data used in CHAOSS metrics
 #' \url{https://chaoss.community/kb-metrics-and-metrics-models/}.
 #'
@@ -23,7 +53,7 @@
 #' \item `repo_from_gh_api` A `data.frame` of a single line, with several key
 #' attributes of the repository on GitHub.
 #' }
-#' @export
+#' @noRd
 rm_data_repo <- function (path) {
 
     checkmate::assert_directory_exists (path)
@@ -51,9 +81,6 @@ get_rm_data_fns <- function () {
     data_fns <- data_fns [which (!grepl ("\\_internal$", data_fns))]
     data_fns <- data_fns [which (!data_fns == "rm_data_repo")]
 
-    index <- grep ("user", data_fns)
-    data_fns <- data_fns [-index]
-
     return (data_fns)
 }
 

R/data-user.R

@@ -18,10 +18,10 @@
 #' \item `issues` with information on all issues opened by user
 #' }
 #' @export
-rm_data_user <- function (login,
-                          ended_at = Sys.time (),
-                          nyears = 1,
-                          n_per_page = 100) {
+repometrics_data_user <- function (login,
+                                   ended_at = Sys.time (),
+                                   nyears = 1,
+                                   n_per_page = 100) {
 
     checkmate::assert_character (login, len = 1L)
 

R/quarto-dashboard.R

@@ -1,8 +1,8 @@
-#' Start quarto dashboard with results of main \link{repometrics_data}
+#' Start quarto dashboard with results of main \link{repometrics_data_pkg}
 #' function.
 #'
-#' @param data Results of main \link{repometrics_data} function applied
-#' to one package.
+#' @param data Results of main \link{repometrics_data_pkg} function applied to
+#' one package.
 #' @param action One of "preview", to start and open a live preview of the
 #' dashboard website, or "render" to render a static version without previewing
 #' or opening.

codemeta.json

@@ -8,7 +8,7 @@
   "codeRepository": "https://github.com/ropensci-review-tools/repometrics",
   "issueTracker": "https://github.com/ropensci-review-tools/repometrics/issues",
   "license": "https://spdx.org/licenses/GPL-3.0",
-  "version": "0.1.3.003",
+  "version": "0.1.3.006",
   "programmingLanguage": {
     "@type": "ComputerLanguage",
     "name": "R",

tests/testthat/test-rm-data-gh-user.R

@@ -69,15 +69,15 @@ test_that ("rm user data internal structures", {
     expect_named (dat$issue_cmts, nms)
 })
 
-test_that ("rm_data_user fn", {
+test_that ("repometrics_data_user fn", {
 
     Sys.setenv ("REPOMETRICS_TESTS" = "true")
     dat_mocked <- mock_rm_data (repo = FALSE)
 
     login <- "mpadge"
     ended_at <- as.POSIXct ("2024-01-01T00:00:00")
 
-    dat <- rm_data_user (
+    dat <- repometrics_data_user (
         login = login,
         n_per_page = 1,
         ended_at = ended_at,