more consistent names of main fns

ropensci-review-tools · Dec 10, 2024 · 6ec5f22 · 6ec5f22
1 parent dbb5b2b
commit 6ec5f22
Show file tree

Hide file tree

Showing 10 changed files with 19 additions and 22 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: repometrics
 Title: Metrics for Your Code Repository
-Version: 0.1.3.005
+Version: 0.1.3.006
 Authors@R: 
     person("Mark", "Padgham", , "[email protected]", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0003-2172-5265"))

diff --git a/NAMESPACE b/NAMESPACE
@@ -2,6 +2,6 @@
 
 export(repo_pkgstats_history)
 export(repometrics_dashboard)
-export(repometrics_pkg_data)
-export(repometrics_user_data)
+export(repometrics_data_pkg)
+export(repometrics_data_user)
 importFrom(memoise,memoise)
diff --git a/R/data-repo.R b/R/data-repo.R
@@ -10,7 +10,7 @@
 #' }
 #'
 #' @export
-repometrics_pkg_data <- function (path, step_days = 1L, num_cores = -1L) {
+repometrics_data_pkg <- function (path, step_days = 1L, num_cores = -1L) {
 
     cli::cli_alert_info ("Extracting package statistics ...")
     pkgstats <- repo_pkgstats_history (
@@ -81,9 +81,6 @@ get_rm_data_fns <- function () {
     data_fns <- data_fns [which (!grepl ("\\_internal$", data_fns))]
     data_fns <- data_fns [which (!data_fns == "rm_data_repo")]
 
-    index <- grep ("user", data_fns)
-    data_fns <- data_fns [-index]
-
     return (data_fns)
 }
 

diff --git a/R/data-user.R b/R/data-user.R
@@ -18,7 +18,7 @@
 #' \item `issues` with information on all issues opened by user
 #' }
 #' @export
-repometrics_user_data <- function (login,
+repometrics_data_user <- function (login,
                                    ended_at = Sys.time (),
                                    nyears = 1,
                                    n_per_page = 100) {

diff --git a/R/quarto-dashboard.R b/R/quarto-dashboard.R
@@ -1,7 +1,7 @@
-#' Start quarto dashboard with results of main \link{repometrics_pkg_data}
+#' Start quarto dashboard with results of main \link{repometrics_data_pkg}
 #' function.
 #'
-#' @param data Results of main \link{repometrics_pkg_data} function applied to
+#' @param data Results of main \link{repometrics_data_pkg} 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

diff --git a/codemeta.json b/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.3.005",
+  "version": "0.1.3.006",
   "programmingLanguage": {
     "@type": "ComputerLanguage",
     "name": "R",

diff --git a/man/repometrics_dashboard.Rd b/man/repometrics_dashboard.Rd
diff --git a/man/repometrics_pkg_data.Rd → man/repometrics_data_pkg.Rd b/man/repometrics_pkg_data.Rd → man/repometrics_data_pkg.Rd
diff --git a/man/repometrics_user_data.Rd → man/repometrics_data_user.Rd b/man/repometrics_user_data.Rd → man/repometrics_data_user.Rd
diff --git a/tests/testthat/test-rm-data-gh-user.R b/tests/testthat/test-rm-data-gh-user.R
@@ -69,15 +69,15 @@ test_that ("rm user data internal structures", {
     expect_named (dat$issue_cmts, nms)
 })
 
-test_that ("rm_data_user fn", {
+test_that ("repometrics_data_user fn", {
 
     Sys.setenv ("REPOMETRICS_TESTS" = "true")
     dat_mocked <- mock_rm_data (repo = FALSE)
 
     login <- "mpadge"
     ended_at <- as.POSIXct ("2024-01-01T00:00:00")
 
-    dat <- rm_data_user (
+    dat <- repometrics_data_user (
         login = login,
         n_per_page = 1,
         ended_at = ended_at,