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

change 'cm_metrics' defs to 'cm_data' for #124

Author: mpadge

DESCRIPTION

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

R/cm-metric-best-practices.R

@@ -9,7 +9,7 @@
 #' provide a consistent interface).
 #'
 #' @noRd
-cm_metric_best_practices <- function (path, end_date = NULL) {
+cm_data_best_practices <- function (path, end_date = NULL) {
     readme_path <- fs::dir_ls (path, regexp = "readme\\.md", ignore.case = TRUE)
     if (length (readme_path) == 0L) {
         return (FALSE)
@@ -21,3 +21,7 @@ cm_metric_best_practices <- function (path, end_date = NULL) {
     ptn <- paste0 (c (ptn_ci, ptn_ossf), collapse = "|")
     return (any (grepl (ptn, readme)))
 }
+
+cm_metric_best_practices <- function (path, end_date = NULL) {
+    cm_data_best_practices (path, end_date)
+}

R/cm-metric-burstiness.R

@@ -9,7 +9,7 @@
 #'
 #' \url{https://chaoss.community/kb/metric-burstiness/}.
 #' @noRd
-cm_metric_burstiness <- function (path, end_date, band_len = 31L, band_width = 2) {
+cm_data_burstiness <- function (path, end_date, band_len = 31L, band_width = 2) {
 
     # Suppress no visible binding notes:
     timestamp <- ncommits <- mn <- sd <- upper <- lower <- outlier <- NULL
@@ -57,3 +57,7 @@ cm_metric_burstiness <- function (path, end_date, band_len = 31L, band_width = 2
 
     return (ret)
 }
+
+cm_metric_burstiness <- function (path, end_date, band_len = 31L, band_width = 2) {
+    cm_data_burstiness (path, end_date, band_len = 31L, band_width = 2)
+}

R/cm-metric-change-req.R

@@ -20,7 +20,7 @@
 #' request.
 #' }
 #' @noRd
-cm_metric_change_req <- function (path, end_date = Sys.Date ()) {
+cm_data_change_req <- function (path, end_date = Sys.Date ()) {
 
     log <- git_log_in_period (path, end_date)
     if (nrow (log) == 0) {
@@ -43,3 +43,8 @@ cm_metric_change_req <- function (path, end_date = Sys.Date ()) {
 
     return (ret)
 }
+
+cm_metric_change_req <- function (path, end_date = Sys.Date ()) {
+
+    cm_data_change_req (path, end_date)
+}

R/cm-metric-code-change.R

@@ -1,6 +1,6 @@
-cm_metric_code_change_lines <- function (path,
-                                         end_date = Sys.Date (),
-                                         exclude_whitespace = TRUE) {
+cm_data_code_change_lines <- function (path,
+                                       end_date = Sys.Date (),
+                                       exclude_whitespace = TRUE) {
 
     log <- git_log_in_period (path, end_date)
 
@@ -12,3 +12,10 @@ cm_metric_code_change_lines <- function (path,
 
     return (changes - ws)
 }
+
+cm_metric_code_change_lines <- function (path,
+                                         end_date = Sys.Date (),
+                                         exclude_whitespace = TRUE) {
+
+    cm_data_code_change_lines (path, end_date, exclude_whitespace)
+}

R/cm-metric-cran-downloads.R

@@ -5,7 +5,7 @@
 #' @param end_date The date up to which download counts are to be aggregated.
 #' @return A single integer counting the number of downloads.
 #' @noRd
-cm_metric_cran_downloads <- function (path, end_date = Sys.Date ()) {
+cm_data_cran_downloads <- function (path, end_date = Sys.Date ()) {
 
     checkmate::assert_directory_exists (path)
     checkmate::assert_date (end_date)
@@ -20,6 +20,10 @@ cm_metric_cran_downloads <- function (path, end_date = Sys.Date ()) {
     return (sum (cran_dl$downloads))
 }
 
+cm_metric_cran_downloads <- function (path, end_date = Sys.Date ()) {
+    cm_data_cran_downloads (path, end_date)
+}
+
 #' Download the full daily log over `nyears`, and use memoised return value to
 #' filter to desired period for subsequent calls.
 #' @noRd

R/cm-metric-ctb-absence.R

@@ -10,7 +10,7 @@
 #' @param path Local path to repository
 #' @param end_date Date at which metric is to be calculated.
 #' @noRd
-cm_metric_contrib_absence <- function (path, end_date = Sys.Date ()) {
+cm_data_contrib_absence <- function (path, end_date = Sys.Date ()) {
 
     checkmate::assert_date (end_date)
 
@@ -21,6 +21,10 @@ cm_metric_contrib_absence <- function (path, end_date = Sys.Date ()) {
     gitlog_absence_factor (log)
 }
 
+cm_metric_contrib_absence <- function (path, end_date = Sys.Date ()) {
+    cm_data_contrib_absence (path, end_date)
+}
+
 gitlog_absence_factor <- function (log) {
 
     # Count number of unique contributors needed to exceed 50%:

R/cm-metric-ctb-count.R

@@ -5,7 +5,7 @@
 #' issue authors, and issue comments participants over a certain period of
 #' time."
 #' @noRd
-cm_metric_ctb_count <- function (path, end_date = Sys.Date ()) {
+cm_data_ctb_count <- function (path, end_date = Sys.Date ()) {
 
     # Suppress no visible binding note:
     created_at <- NULL
@@ -30,6 +30,10 @@ cm_metric_ctb_count <- function (path, end_date = Sys.Date ()) {
     )
 }
 
+cm_metric_ctb_count <- function (path, end_date = Sys.Date ()) {
+    cm_data_ctb_count (path, end_date)
+}
+
 #' CHAOSS metric for committer count
 #'
 #' \url{https://chaoss.community/kb/metric-committers/}.
@@ -40,7 +44,7 @@ cm_metric_ctb_count <- function (path, end_date = Sys.Date ()) {
 #'  D2_count: Contributors who have created a merge request and successfully
 #'    merged code."
 #' @noRd
-cm_metric_committer_count <- function (path, end_date = Sys.Date ()) {
+cm_data_committer_count <- function (path, end_date = Sys.Date ()) {
 
     # Suppress no visible binding note:
     starred_at <- created <- org_repo <- created_at <- NULL
@@ -72,3 +76,7 @@ cm_metric_committer_count <- function (path, end_date = Sys.Date ()) {
         prs = length (ctbs2)
     )
 }
+
+cm_metric_committer_count <- function (path, end_date = Sys.Date ()) {
+    cm_data_committer_count (path, end_date)
+}

R/cm-metric-ctb-types.R

@@ -8,7 +8,7 @@
 #' \url{https://chaoss.community/kb/metric-types-of-contributions/}.
 #'
 #' @noRd
-cm_metric_ctb_diversity <- function (path, end_date = Sys.Date ()) {
+cm_data_ctb_diversity <- function (path, end_date = Sys.Date ()) {
 
     # Suppress no visible binding notes:
     updated_at <- NULL
@@ -39,3 +39,7 @@ cm_metric_ctb_diversity <- function (path, end_date = Sys.Date ()) {
 
     return (length (setdiff (cmt_aut, main_auts)) / length (main_auts))
 }
+
+cm_metric_ctb_diversity <- function (path, end_date = Sys.Date ()) {
+    cm_data_ctb_diversity (path, end_date)
+}

R/cm-metric-elephant-factor.R

@@ -5,7 +5,7 @@
 #' \url{https://chaoss.community/kb/metric-elephant-factor/}.
 #'
 #' @noRd
-cm_metric_elephant_factor <- function (path, end_date = Sys.Date ()) {
+cm_data_elephant_factor <- function (path, end_date = Sys.Date ()) {
 
     # Suppress no visible binding note:
     name <- company <- ncommits <- nfiles_changed <- lines_changed <- NULL
@@ -35,3 +35,7 @@ cm_metric_elephant_factor <- function (path, end_date = Sys.Date ()) {
 
     gitlog_absence_factor (log)
 }
+
+cm_metric_elephant_factor <- function (path, end_date = Sys.Date ()) {
+    cm_data_elephant_factor (path, end_date)
+}

R/cm-metric-has-ci.R

@@ -28,7 +28,7 @@ has_gh_ci_tests <- function (path) {
 
 # 'end_date' not used here, but specified for consistent interface to all
 # metric fns.
-cm_metric_has_ci <- function (path, end_date = NULL) {
+cm_data_has_ci <- function (path, end_date = NULL) {
 
     is_test_env <- Sys.getenv ("REPOMETRICS_TESTS") == "true"
     has_ci <- ifelse (is_test_env, FALSE, has_gh_ci_tests (path))
@@ -46,3 +46,7 @@ cm_metric_has_ci <- function (path, end_date = NULL) {
 
     return (has_ci)
 }
+
+cm_metric_has_ci <- function (path, end_date = NULL) {
+    cm_data_has_ci (path, end_date)
+}

R/cm-metric-issue-updates.R

@@ -3,7 +3,7 @@
 #' \url{https://chaoss.community/kb/metrics-model-community-activity/}
 #' "The number of issues updated over a certain period of time."
 #' @noRd
-cm_metric_issue_updates <- function (path, end_date = Sys.Date ()) {
+cm_data_issue_updates <- function (path, end_date = Sys.Date ()) {
 
     # Suppress no visible binding note:
     created_at <- NULL
@@ -21,7 +21,11 @@ cm_metric_issue_updates <- function (path, end_date = Sys.Date ()) {
     length (issue_nums)
 }
 
-cm_metric_issue_cmt_count <- function (path, end_date = Sys.Date ()) {
+cm_metric_issue_updates <- function (path, end_date = Sys.Date ()) {
+    cm_data_issue_updates (path, end_date)
+}
+
+cm_data_issue_cmt_count <- function (path, end_date = Sys.Date ()) {
 
     # Suppress no visible binding note:
     created_at <- issue_number <- NULL
@@ -48,7 +52,11 @@ cm_metric_issue_cmt_count <- function (path, end_date = Sys.Date ()) {
     return (mn_med_sum (cmts))
 }
 
-cm_metric_issues_closed <- function (path, end_date = Sys.Date ()) {
+cm_metric_issue_cmt_count <- function (path, end_date = Sys.Date ()) {
+    cm_data_issue_cmt_count (path, end_date)
+}
+
+cm_data_issues_closed <- function (path, end_date = Sys.Date ()) {
 
     # Suppress no visible binding note:
     closed_at <- NULL
@@ -62,3 +70,7 @@ cm_metric_issues_closed <- function (path, end_date = Sys.Date ()) {
 
     nrow (issues)
 }
+
+cm_metric_issues_closed <- function (path, end_date = Sys.Date ()) {
+    cm_data_issues_closed (path, end_date)
+}

R/cm-metric-issues-to-prs.R

@@ -1,4 +1,4 @@
-cm_metric_issues_to_prs <- function (path, end_date = Sys.Date ()) {
+cm_data_issues_to_prs <- function (path, end_date = Sys.Date ()) {
 
     prs <- get_prs_in_period (path, end_date) # in cm-metrics-change-req.R
     issues <- get_issues_in_period (path, end_date)
@@ -11,6 +11,10 @@ cm_metric_issues_to_prs <- function (path, end_date = Sys.Date ()) {
     return (ret)
 }
 
+cm_metric_issues_to_prs <- function (path, end_date = Sys.Date ()) {
+    cm_data_issues_to_prs (path, end_date)
+}
+
 get_issues_in_period <- function (path,
                                   end_date = Sys.Date (),
                                   closed_only = FALSE) {

R/cm-metric-labels.R

@@ -20,7 +20,7 @@
 #' have been added at any time after an actual creation date of each issue.
 #'
 #' @noRd
-cm_metric_label_inclusivity <- function (path, end_date = Sys.Date ()) {
+cm_data_label_inclusivity <- function (path, end_date = Sys.Date ()) {
 
     # suppress no visible binding notes:
     created_at <- NULL
@@ -53,3 +53,7 @@ cm_metric_label_inclusivity <- function (path, end_date = Sys.Date ()) {
         prop_friendly_overall = prop_friendly_overall
     )
 }
+
+cm_metric_label_inclusivity <- function (path, end_date = Sys.Date ()) {
+    cm_data_label_inclusivity (path, end_date)
+}

R/cm-metric-languages.R

@@ -6,7 +6,7 @@
 #' @param end_date Not used here, but specified for consistent interface to all
 #' metric fns.
 #' @noRd
-cm_metric_languages <- function (path, end_date = NULL) {
+cm_data_languages <- function (path, end_date = NULL) {
 
     # Suppress no visible binding note:
     language <- nfiles <- ncode <- NULL
@@ -37,3 +37,7 @@ cm_metric_languages <- function (path, end_date = NULL) {
             ncode_pc = ifelse (sum (ncode) == 0, 0, ncode / sum (ncode))
         )
 }
+
+cm_metric_languages <- function (path, end_date = NULL) {
+    cm_data_languages (path, end_date)
+}

R/cm-metric-licenses.R

@@ -22,9 +22,9 @@ cm_metric_licenses_declared <- function (path, end_date = NULL) {
 #' @param dirs Directories to include in assessing files for license coverage.
 #' metric fns.
 #' @noRd
-cm_metric_license_coverage <- function (path,
-                                        end_date = NULL,
-                                        dirs = c ("R", "src", "inst/extdata")) {
+cm_data_license_coverage <- function (path,
+                                      end_date = NULL,
+                                      dirs = c ("R", "src", "inst/extdata")) {
 
     requireNamespace ("readr", quietly = TRUE)
 
@@ -64,6 +64,13 @@ cm_metric_license_coverage <- function (path,
     return (length (which (has_license)) / length (flist))
 }
 
+cm_metric_license_coverage <- function (path,
+                                        end_date = NULL,
+                                        dirs = c ("R", "src", "inst/extdata")) {
+
+    cm_data_license_coverage (path, end_date, dirs)
+}
+
 included_exts <- c ("r", "q", "qmd", "rmd", "c", "cpp", "h", "js", "py")
 
 # https://www.r-project.org/Licenses/

R/cm-metric-maintainer-count.R

@@ -3,7 +3,7 @@
 #' counting only those who were active either in commits, issues, or pull
 #' requests over the standard time period.
 #' @noRd
-cm_metric_maintainer_count <- function (path, end_date = Sys.Date ()) {
+cm_data_maintainer_count <- function (path, end_date = Sys.Date ()) {
 
     # Suppress no visible binding note:
     user_login <- merged_by <- participants <- created_at <-
@@ -47,6 +47,10 @@ cm_metric_maintainer_count <- function (path, end_date = Sys.Date ()) {
     c (total = nrow (auts), recent = num_gh_auts)
 }
 
+cm_metric_maintainer_count <- function (path, end_date = Sys.Date ()) {
+    cm_data_maintainer_count (path, end_date)
+}
+
 #' Match repo contributors from both git log and GitHub API to author names and
 #' emails given in "DESCRIPTION" file.
 #'

R/cm-metric-num-ctb.R

@@ -1,4 +1,4 @@
-cm_metric_num_contributors <- function (path, end_date = Sys.Date ()) {
+cm_data_num_contributors <- function (path, end_date = Sys.Date ()) {
 
     log <- git_log_in_period (path, end_date)
 
@@ -23,3 +23,7 @@ cm_metric_num_contributors <- function (path, end_date = Sys.Date ()) {
 
     return (length (index))
 }
+
+cm_metric_num_contributors <- function (path, end_date = Sys.Date ()) {
+    cm_data_num_contributors (path, end_date)
+}

R/cm-metric-num-forks.R

@@ -1,4 +1,4 @@
-cm_metric_num_forks <- function (path, end_date = Sys.Date ()) {
+cm_data_num_forks <- function (path, end_date = Sys.Date ()) {
 
     forks <- rm_data_repo_forks (path)
 
@@ -7,3 +7,7 @@ cm_metric_num_forks <- function (path, end_date = Sys.Date ()) {
 
     return (c (num_in_period = length (index), num_total = nrow (forks)))
 }
+
+cm_metric_num_forks <- function (path, end_date = Sys.Date ()) {
+    cm_data_num_forks (path, end_date)
+}

R/cm-metric-popularity.R

@@ -1,4 +1,4 @@
-cm_metric_popularity <- function (path, end_date = Sys.Date ()) {
+cm_data_popularity <- function (path, end_date = Sys.Date ()) {
 
     # suppress no visible binding notes:
     timestamp <- aut_email <- aut_name <- created <- starred_at <- NULL
@@ -26,3 +26,7 @@ cm_metric_popularity <- function (path, end_date = Sys.Date ()) {
         stars = nrow (stars)
     )
 }
+
+cm_metric_popularity <- function (path, end_date = Sys.Date ()) {
+    cm_data_popularity (path, end_date)
+}