Merge pull request #128 from ropensci-review-tools/models

more cm_metric updates for #124

Author: mpadge

DESCRIPTION

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

R/cm-metric-ctb-count.R

@@ -30,8 +30,10 @@ cm_data_ctb_count <- function (path, end_date = Sys.Date ()) {
     )
 }
 
+# Only code contributions are actually counted
 cm_metric_ctb_count <- function (path, end_date = Sys.Date ()) {
-    cm_data_ctb_count (path, end_date)
+    dat <- cm_data_ctb_count (path, end_date)
+    return (dat [["code"]])
 }
 
 #' CHAOSS metric for committer count

R/cm-metrics-pr-reviews.R

@@ -232,7 +232,8 @@ cm_data_pr_age <- function (path, end_date = Sys.Date ()) {
 }
 
 cm_metric_pr_age <- function (path, end_date = Sys.Date ()) {
-    cm_data_pr_age (path, end_date)
+    dat <- cm_data_pr_age (path, end_date)
+    return (dat [["mean"]])
 }
 
 #' CHAOSS metric "Change Request Reviews", which assesses "to what extent are

R/cm-models.R

@@ -74,7 +74,7 @@ cm_model_proj_engagement <- function (path,
         # has number of unique commiters for (watchers or forks, issues, prs)
 
         num_code_ctbs <-
-            cm_metric_ctb_count (path, end_date = end_date) [["code"]]
+            cm_metric_ctb_count (path, end_date = end_date)
 
         num_issues_closed <-
             cm_metric_issues_closed (path, end_date = end_date)
@@ -159,7 +159,7 @@ cm_model_community_activity <- function (path,
 
 
         # ----- Single integer results which can be directly added:
-        ctbs <- cm_metric_ctb_count (path, end_date = end_date)
+        num_code_ctbs <- cm_metric_ctb_count (path, end_date = end_date)
         # Those are [code, pr_authors, issue_authors, issue_cmt_authors], each
         # as number of unique authors.
         prs_approved <- cm_metric_pr_revs_approved (path, end_date = end_date)
@@ -176,7 +176,7 @@ cm_model_community_activity <- function (path,
 
     } else {
 
-        ctbs <- metrics_data$ctb_count
+        num_code_ctbs <- metrics_data$ctb_count
         prs_approved <- metrics_data$pr_reviews_approved
         num_releases <- metrics_data$recent_releases
         issues_updated <- metrics_data$issue_updates
@@ -188,7 +188,7 @@ cm_model_community_activity <- function (path,
     }
 
     res <- c (
-        ctbs, prs_approved, num_releases, issues_updated,
+        num_code_ctbs, prs_approved, num_releases, issues_updated,
         num_maintainers, commit_count, comment_counts
     )
     res [which (res == 0)] <- 1
@@ -524,8 +524,6 @@ cm_model_comm_serv_support <- function (path,
 
     }
 
-    pr_age <- pr_age [["mean"]]
-
     res_N_days <- c (issue_resp_time, issue_age, issue_res_duration, pr_age, pr_dur_mn)
     res_ON <-
         c (issue_num_cmts, issues_active, pr_num_revs_approved, pr_num_revs_rejected)
@@ -647,7 +645,6 @@ cm_model_comm_welcoming <- function (path,
         c (lic_coverage, lic_declared, bp_badge, test_cov, pr_closure_ratio)
 
     # ----- Values in [0, N] for which higher are better:
-    num_code_ctbs <- num_code_ctbs [["code"]]
     num_code_ctbs <- ifelse (num_code_ctbs == 0, 1, num_code_ctbs)
 
     val_0N <- log10 (c (bus, ele, num_code_ctbs))

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

tests/testthat/test-cm-metrics.R

@@ -194,8 +194,9 @@ test_that ("cm metric pr-reviews", { # R/cm-metric-pr-review.R
     expect_true (all (cmts [which (!is.na (cmts))] >= 0))
 
     expect_type (age, "double")
-    expect_length (age, 4L)
-    expect_named (age, c ("mean", "sd", "median", "sum"))
+    expect_length (age, 1L)
+    expect_named (age, NULL)
+    expect_true (is.na (age))
 
     expect_type (prs_approved, "integer")
     expect_length (prs_approved, 1L)
@@ -494,20 +495,27 @@ test_that ("cm metric ctb and committer count", { # R/cm-metric-ctb-count.R
     dat <- mock_rm_data ()
     path <- generate_test_pkg ()
 
-    counts_ctb <- cm_metric_ctb_count (path, end_date = end_date)
+    # data has [code, pr_authors, issue_authors, issue_cmt_authors]
+    data_ctb <- cm_data_ctb_count (path, end_date = end_date)
+    counts_ctb <- cm_metric_ctb_count (path, end_date = end_date) # code only
     counts_cmt <- cm_metric_committer_count (path, end_date = end_date)
     counts_watchers <- cm_metric_watcher_count (path, end_date = end_date)
 
     fs::dir_delete (path)
 
-    expect_type (counts_ctb, "integer")
-    expect_length (counts_ctb, 4L)
+    expect_type (data_ctb, "integer")
+    expect_length (data_ctb, 4L)
     expect_named (
-        counts_ctb,
+        data_ctb,
         c ("code", "pr_authors", "issue_authors", "issue_cmt_authors")
     )
-    expect_true (all (counts_ctb >= 0L))
-    expect_true (sum (counts_ctb) > 0L)
+    expect_true (all (data_ctb >= 0L))
+    expect_true (sum (data_ctb) > 0L)
+
+    expect_type (counts_ctb, "integer")
+    expect_length (counts_ctb, 1L)
+    expect_named (counts_ctb, NULL)
+    expect_true (counts_ctb >= 0L)
 
     expect_type (counts_cmt, "integer")
     expect_length (counts_cmt, 3L)
@@ -645,9 +653,9 @@ test_that ("cm metric collate all", {
     lens <- vapply (metrics_data, length, integer (1L), USE.NAMES = FALSE)
     lens_expected <- as.integer (c (
         1, 1, 1, 1, 1, 1, 1, 1, 3, 1,
-        1, 4, 1, 1, 1, 1, 1, 1, 4, 1,
+        1, 1, 1, 1, 1, 1, 1, 1, 4, 1,
         1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
-        1, 1, 1, 1, 1, 4, 1, 4, 0, 1,
+        1, 1, 1, 1, 1, 1, 1, 4, 0, 1,
         1, 1, 1, 1, 1, 4, 3, 1, 1
     ))
     expect_equal (lens, lens_expected)