Merge pull request #120 from ropensci-review-tools/single-data

Reduce dashboard input to single parameter for #114

Author: mpadge

DESCRIPTION

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

R/data-repo.R

@@ -22,7 +22,19 @@
 #' @param nyears Parameter <= 1 determining fraction of a year over which data
 #' up until `end_date` are collected.
 #'
-#' @return data
+#' @return A list of three forms of data:
+#' \enumerate{
+#' \item "pkgstats" containing statistics on the historical development of
+#' package code, derived from the \pkg{pkgstats} package;
+#' \item "rm" containing data from GitHub on the repository, including data on
+#' contributors, issues, pull requests, and people watching and starring the
+#' repository.
+#' \item "contributors" as a named list of data on every individual contributor
+#' to the repository, whether by code contributions or GitHub issues or
+#' discussions.
+#' }
+#'
+#' @family data
 #' @export
 repometrics_data <- function (path, step_days = 1L, num_cores = -1L,
                               ended_at = Sys.time (), nyears = 1) {

R/quarto-dashboard.R

@@ -1,10 +1,8 @@
 #' Start quarto dashboard with results of main \link{repometrics_data_repo}
 #' function.
 #'
-#' @param data_repo Data on repository as returned from
-#' \link{repometrics_data_repo} function applied to one package.
-#' @param data_users Data on repository developers ("users" in GitHub terms), as
-#' returned from \link{repometrics_data_user} function applied to one package.
+#' @param data Data on repository and all contributors as returned from
+#' \link{repometrics_data} 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.
@@ -23,25 +21,39 @@
 #'
 #' @family dashboard
 #' @export
-repometrics_dashboard <- function (data_repo, data_users, action = "preview",
+repometrics_dashboard <- function (data, action = "preview",
                                    ctb_threshold = NULL, max_ctbs = NULL) {
 
     if (!is.null (ctb_threshold)) {
-        checkmate::assert_numeric (ctb_threshold, len = 1L, lower = 0, upper = 1)
+        checkmate::assert_numeric (
+            ctb_threshold,
+            len = 1L,
+            lower = 0,
+            upper = 1
+        )
         if (!is.null (max_ctbs)) {
-            cli::cli_abort ("Only one of 'ctb_threshold' or 'max_ctbs' may be specified.")
+            cli::cli_abort (
+                "Only one of 'ctb_threshold' or 'max_ctbs' may be specified."
+            )
         }
     }
     if (!is.null (max_ctbs)) {
-        checkmate::assert_integerish (max_ctbs, len = 1L, lower = 1, upper = length (data_users))
+        checkmate::assert_integerish (
+            max_ctbs,
+            len = 1L,
+            lower = 1,
+            upper = length (data$contributors)
+        )
     }
 
+    data_ctbs <- data$contributors
+    data$contributors <- NULL
     if (!is.null (ctb_threshold) || !is.null (max_ctbs)) {
-        data_users <- reduce_data_users (data_users, ctb_threshold, max_ctbs)
+        data_ctbs <- reduce_data_users (data_ctbs, ctb_threshold, max_ctbs)
     }
 
-    check_dashboard_arg (data_repo)
-    data_repo$pkgstats <- timestamps_to_dates (data_repo$pkgstats)
+    check_dashboard_arg (data)
+    data$pkgstats <- timestamps_to_dates (data$pkgstats)
 
     requireNamespace ("brio")
     requireNamespace ("jsonlite")
@@ -54,16 +66,16 @@ repometrics_dashboard <- function (data_repo, data_users, action = "preview",
     path_src <- system.file ("extdata", "quarto", package = "repometrics")
     path_dest <- fs::path (fs::path_temp (), "quarto")
     dir <- fs::dir_copy (path_src, path_dest, overwrite = TRUE)
-    saveRDS (data_repo, fs::path (dir, "results-repo.Rds"))
-    saveRDS (data_users, fs::path (dir, "results-users.Rds"))
+    saveRDS (data, fs::path (dir, "results-repo.Rds"))
+    saveRDS (data_ctbs, fs::path (dir, "results-users.Rds"))
 
-    dat_user_network <- get_user_network (data_repo, data_users)
+    dat_user_network <- get_user_network (data, data_ctbs)
     jsonlite::write_json (
         dat_user_network,
         fs::path (dir, "results-user-network.json")
     )
 
-    pkg_name <- data_repo$pkgstats$desc_data$package [1]
+    pkg_name <- data$pkgstats$desc_data$package [1]
     quarto_insert_pkg_name (dir, pkg_name)
 
     withr::with_dir (dir, {
@@ -248,7 +260,7 @@ timestamps_to_dates <- function (data) {
                 dplyr::ungroup ()
         }
 
-        return (dplyr::arrange (i, by = dplyr::desc (date)))
+        dplyr::arrange (i, by = dplyr::desc (date))
     })
 }
 

README.md

@@ -36,29 +36,22 @@ pak::pkg_install ("ropensci-review-tools/repometrics")
 
 ### Use
 
-The dashboard requires two sources of data, beginning with core data of a focal
-repository. Code for that repository must exist in a local directory
-corresponding to the single input parameter, `path`:
+The `repometrics` package has one main function for collating all data for a
+repository:
+[`repometrics_data()`](https://docs.ropensci.org/repometrics/reference/repometrics_data.html).
+This function has one main parameter, specifying the `path` to a local
+directory containing an R package.
 
 ``` r
-data_repo <- repometrics_data_repo (path)
+data <- repometrics_data (path)
 ```
 
-The second data source is then information on all people who have contributed
-to the repository, both by direct code commits and via GitHub. The following
-lines extract information on each of those contributors:
+A `repometrics` dashboard for the repository can then be launched by passing
+those `data` to [the `repometrics_dashboard()`
+function](https://docs.ropensci.org/repometrics/reference/repometrics_dashboard.html):
 
 ``` r
-ctbs <- data_repo$rm$contribs_from_gh_api$login
-data_ctbs <- lapply (ctbs, repometrics_data_user)
-names (data_ctbs) <- ctbs
-```
-
-A `repometrics` dashboard for the repository can then be launched with the
-following line:
-
-``` r
-repometrics_dashboard (data_repo, data_ctbs)
+repometrics_dashboard (data)
 ```
 
 The dashboard will automatically open in your default browser.

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

man/repo_pkgstats_history.Rd

@@ -11,67 +11,67 @@ pkg <- system.file ("extdata", "testpkg.zip", package = "repometrics")
 flist <- unzip (pkg, exdir = fs::path_temp ())
 path <- fs::path_dir (flist [1])
 pkgstats <- repo_pkgstats_history (path, num_cores = 1L)
-data0 <- list (pkgstats = pkgstats, rm = rm_data)
 
 num_users <- 4L
-data_users <- lapply (seq_len (num_users), function (i) mock_user_rel_data ())
-names (data_users) <- letters [seq_len (length (data_users))]
+data_ctbs <- lapply (seq_len (num_users), function (i) mock_user_rel_data ())
+names (data_ctbs) <- letters [seq_len (length (data_ctbs))]
+
+data0 <- list (pkgstats = pkgstats, rm = rm_data, contributors = data_ctbs)
 
 # --------- pre-process end --------
 
 test_that ("dashboard input errors", {
 
     data <- data0
     expect_error (
-        repometrics_dashboard (data, data_users, action = "noarg"),
+        repometrics_dashboard (data, action = "noarg"),
         "\\'arg\\' should be one of"
     )
     names (data) [1] <- "changed"
     expect_error (
-        repometrics_dashboard (data, data_users, action = "render"),
+        repometrics_dashboard (data, action = "render"),
         "Assertion on \\'names\\(data\\)\\' failed\\: Names must be "
     )
 
     data$pkgstats$stats <- data$pkgstats$stats [, -1]
     expect_error (
-        repometrics_dashboard (data, data_users, action = "render"),
+        repometrics_dashboard (data, action = "render"),
         "Assertion on \\'names\\(data\\)\\' failed\\: Names must be "
     )
 
     data <- data0
     data$pkgstats$stats <-
         data$pkgstats$stats [-seq_len (nrow (data$pkgstats$stats)), ]
     expect_error (
-        repometrics_dashboard (data, data_users, action = "render"),
+        repometrics_dashboard (data, action = "render"),
         "\\'data\\' contains empty tables."
     )
 
     expect_error (
-        repometrics_dashboard (data, data_users, ctb_threshold = "a"),
+        repometrics_dashboard (data, ctb_threshold = "a"),
         paste0 (
             "Assertion on \\'ctb\\_threshold\\' failed\\: ",
             "Must be of type \\'numeric\\'"
         )
     )
     expect_error (
-        repometrics_dashboard (data, data_users, ctb_threshold = 2),
+        repometrics_dashboard (data, ctb_threshold = 2),
         "Assertion on \\'ctb\\_threshold\\' failed\\: Element 1 is not <= 1"
     )
     expect_error (
-        repometrics_dashboard (data, data_users, max_ctbs = "a"),
+        repometrics_dashboard (data, max_ctbs = "a"),
         paste0 (
             "Assertion on \\'max\\_ctbs\\' failed\\: ",
             "Must be of type \\'integerish\\'"
         )
     )
     expect_error (
-        repometrics_dashboard (data, data_users, max_ctbs = 0),
+        repometrics_dashboard (data, max_ctbs = 0),
         "Assertion on \\'max\\_ctbs\\' failed\\: Element 1 is not >= 1"
     )
     expect_error (
         repometrics_dashboard (
             data,
-            data_users,
             ctb_threshold = 0.5,
             max_ctbs = 2
         ),
@@ -81,14 +81,14 @@ test_that ("dashboard input errors", {
 
 test_that ("dashboard build", {
 
-    data_repo <- data0
-    repometrics_dashboard (data_repo, data_users, action = "render")
+    data <- data0
+    repometrics_dashboard (data, action = "render")
 
     # Expect quarto docs to have been modified with package name:
     path_tmp <- fs::path (fs::path_temp (), "quarto")
     expect_true (fs::dir_exists (path_tmp))
 
-    pkg_name <- data_repo$pkgstats$desc_data$package [1]
+    pkg_name <- data$pkgstats$desc_data$package [1]
     f_index <- fs::path (path_tmp, "index.qmd")
     index_qmd <- brio::read_lines (f_index)
     i <- grep ("^title\\:", index_qmd)
@@ -120,11 +120,10 @@ test_that ("dashboard build", {
 
 test_that ("dashboard with user reduction", {
 
-    data_repo <- data0
+    data <- data0
     max_ctbs <- 2L
     repometrics_dashboard (
-        data_repo,
-        data_users,
+        data,
         max_ctbs = max_ctbs,
         action = "render"
     )
@@ -148,12 +147,13 @@ test_that ("dashboard with user reduction", {
 
 test_that ("reduce_data_users", {
 
-    data_users_red <- reduce_data_users (data_users, max_ctb = 2L)
-    expect_length (data_users, num_users)
-    expect_length (data_users_red, 2L)
+    max_ctbs <- 2L
+    data_ctbs_red <- reduce_data_users (data_ctbs, max_ctbs = max_ctbs)
+    expect_length (data_ctbs, num_users)
+    expect_length (data_ctbs_red, max_ctbs)
 
-    data_users_red <- reduce_data_users (data_users, ctb_threshold = 0.5)
-    expect_true (length (data_users_red) < length (data_users))
+    data_ctbs_red <- reduce_data_users (data_ctbs, ctb_threshold = 0.5)
+    expect_true (length (data_ctbs_red) < length (data_ctbs))
 })
 
 if (fs::dir_exists (path)) {