add 'models/metrics_over_end_dates fns for #87

Author: mpadge

DESCRIPTION

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

R/cm-collate-all.R

@@ -57,3 +57,31 @@ collate_all_models <- function (path,
 
     return (model_data)
 }
+
+metrics_over_end_dates <- function (path, end_date = Sys.Date (), num_years = 3) {
+
+    end_dates <- get_end_date_seq (end_date = end_date, num_years = num_years)
+
+    metrics_data <- lapply (
+        end_dates,
+        function (d) collate_all_metrics (path, end_date = d)
+    )
+    names (metrics_data) <- as.character (end_dates)
+    attr (metrics_data, "period") <- get_repometrics_period ()
+
+    return (metrics_data)
+}
+
+models_over_end_dates <- function (path, end_date = Sys.Date (), num_years = 3) {
+
+    end_dates <- get_end_date_seq (end_date = end_date, num_years = num_years)
+
+    models_data <- lapply (
+        end_dates,
+        function (d) collate_all_models (path, end_date = d)
+    )
+    models_data <- data.frame (do.call (rbind, models_data)) |>
+        dplyr::mutate (models_data, date = end_dates, .before = 1)
+
+    return (models_data)
+}

R/utils.R

@@ -47,3 +47,15 @@ n_per_page_in_tests <- function (n_per_page) {
     is_test_env <- Sys.getenv ("REPOMETRICS_TESTS") == "true"
     ifelse (is_test_env, 2L, n_per_page)
 }
+
+# Fn used in collating all metrics over ranges of end dates:
+get_end_date_seq <- function (end_date = Sys.Date (),
+                              period = get_repometrics_period (),
+                              num_years = 3) {
+
+    num_periods <- num_years * 365.25 / period
+    period_seq <- seq_len (num_periods) * period - period
+    end_dates <- Sys.Date () - period_seq
+
+    return (end_dates)
+}

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