rename 'rm_data_user' -> 'repometrics_user_data'

Author: mpadge

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: repometrics
 Title: Metrics for Your Code Repository
-Version: 0.1.3.004
+Version: 0.1.3.005
 Authors@R: 
     person("Mark", "Padgham", , "mark.padgham@email.com", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0003-2172-5265"))

NAMESPACE

@@ -3,6 +3,5 @@
 export(repo_pkgstats_history)
 export(repometrics_dashboard)
 export(repometrics_pkg_data)
-export(rm_data_repo)
-export(rm_data_user)
+export(repometrics_user_data)
 importFrom(memoise,memoise)

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_pkg_data <- 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)

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_user_data <- function (login,
+                                   ended_at = Sys.time (),
+                                   nyears = 1,
+                                   n_per_page = 100) {
 
     checkmate::assert_character (login, len = 1L)
 

R/repometrics-data.R

@@ -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.004",
+  "version": "0.1.3.005",
   "programmingLanguage": {
     "@type": "ComputerLanguage",
     "name": "R",