Merge pull request #170 from hubverse-org/ak/rename-get_derived_task_…

…ids/169 Rename get_derived_task_ids to get_hub_derived_task_ids. Resolves #169
hubverse-org · Nov 22, 2024 · 80c943b · 80c943b
2 parents 5f34344 + a7f1b32
commit 80c943b
Show file tree

Hide file tree

Showing 22 changed files with 31 additions and 31 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -78,7 +78,7 @@ importFrom(dplyr,"%>%")
 importFrom(hubAdmin,validate_hub_config)
 importFrom(hubData,coerce_to_hub_schema)
 importFrom(hubData,create_hub_schema)
-importFrom(hubUtils,get_derived_task_ids)
+importFrom(hubUtils,get_hub_derived_task_ids)
 importFrom(hubUtils,get_hub_file_formats)
 importFrom(hubUtils,get_hub_model_output_dir)
 importFrom(hubUtils,get_hub_timezone)

diff --git a/R/check_tbl_spl_compound_taskid_set.R b/R/check_tbl_spl_compound_taskid_set.R
@@ -11,7 +11,7 @@
 #' @param derived_task_ids Character vector of derived task ID names (task IDs whose
 #' values depend on other task IDs) to ignore. Columns for such task ids will
 #' contain `NA`s. Defaults to extracting derived task IDs from hub `task.json`. See
-#' [get_derived_task_ids()] for more details.
+#' [get_hub_derived_task_ids()] for more details.
 #' @inheritParams expand_model_out_grid
 #' @details If the check fails, the output of the check includes an `errors` element,
 #' a list of items, one for each modeling task failing validation.
@@ -38,7 +38,7 @@
 #' @export
 check_tbl_spl_compound_taskid_set <- function(
     tbl, round_id, file_path, hub_path,
-    derived_task_ids = get_derived_task_ids(hub_path)) {
+    derived_task_ids = get_hub_derived_task_ids(hub_path)) {
   config_tasks <- read_config(hub_path, "tasks")
 
   if (isFALSE(has_spls_tbl(tbl)) || isFALSE(hubUtils::is_v3_config(config_tasks))) {

diff --git a/R/check_tbl_spl_compound_tid.R b/R/check_tbl_spl_compound_tid.R
@@ -20,7 +20,7 @@
 #' @export
 check_tbl_spl_compound_tid <- function(tbl, round_id, file_path, hub_path,
                                        compound_taskid_set = NULL,
-                                       derived_task_ids = get_derived_task_ids(hub_path, round_id)) {
+                                       derived_task_ids = get_hub_derived_task_ids(hub_path, round_id)) {
   if (!is.null(compound_taskid_set) && isTRUE(is.na(compound_taskid_set))) {
     cli::cli_abort("Valid {.var compound_taskid_set} must be provided.")
   }

diff --git a/R/check_tbl_spl_n.R b/R/check_tbl_spl_n.R
@@ -17,7 +17,7 @@
 #' @export
 check_tbl_spl_n <- function(tbl, round_id, file_path, hub_path,
                             compound_taskid_set = NULL,
-                            derived_task_ids = get_derived_task_ids(hub_path, round_id)) {
+                            derived_task_ids = get_hub_derived_task_ids(hub_path, round_id)) {
   if (!is.null(compound_taskid_set) && isTRUE(is.na(compound_taskid_set))) {
     cli::cli_abort("Valid {.var compound_taskid_set} must be provided.")
   }

diff --git a/R/check_tbl_spl_non_compound_tid.R b/R/check_tbl_spl_non_compound_tid.R
@@ -18,7 +18,7 @@
 #' @export
 check_tbl_spl_non_compound_tid <- function(tbl, round_id, file_path, hub_path,
                                            compound_taskid_set = NULL,
-                                           derived_task_ids = get_derived_task_ids(hub_path, round_id)) {
+                                           derived_task_ids = get_hub_derived_task_ids(hub_path, round_id)) {
   if (!is.null(compound_taskid_set) && isTRUE(is.na(compound_taskid_set))) {
     cli::cli_abort("Valid {.var compound_taskid_set} must be provided.")
   }

diff --git a/R/check_tbl_value_col.R b/R/check_tbl_value_col.R
@@ -9,7 +9,7 @@
 #' @inheritParams expand_model_out_grid
 #' @export
 check_tbl_value_col <- function(tbl, round_id, file_path, hub_path,
-                                derived_task_ids = get_derived_task_ids(hub_path, round_id)) {
+                                derived_task_ids = get_hub_derived_task_ids(hub_path, round_id)) {
   config_tasks <- read_config(hub_path, "tasks")
 
   tbl[, names(tbl) != "value"] <- hubData::coerce_to_character(

diff --git a/R/check_tbl_values.R b/R/check_tbl_values.R
@@ -6,7 +6,7 @@
 #' @inherit check_tbl_colnames return
 #' @export
 check_tbl_values <- function(tbl, round_id, file_path, hub_path,
-                             derived_task_ids = get_derived_task_ids(hub_path, round_id)) {
+                             derived_task_ids = get_hub_derived_task_ids(hub_path, round_id)) {
   config_tasks <- read_config(hub_path, "tasks")
 
   valid_tbl <- tbl %>%

diff --git a/R/check_tbl_values_required.R b/R/check_tbl_values_required.R
@@ -12,7 +12,7 @@
 #' task ID values will result in **false validation errors when validating
 #' required values**.
 check_tbl_values_required <- function(tbl, round_id, file_path, hub_path,
-                                      derived_task_ids = get_derived_task_ids(hub_path)) {
+                                      derived_task_ids = get_hub_derived_task_ids(hub_path)) {
   tbl[["value"]] <- NULL
   config_tasks <- read_config(hub_path, "tasks")
 

diff --git a/R/imports-hubUtils.R b/R/imports-hubUtils.R
@@ -7,5 +7,5 @@ NULL
 #' @importFrom hubUtils get_hub_model_output_dir
 NULL
 
-#' @importFrom hubUtils get_derived_task_ids
+#' @importFrom hubUtils get_hub_derived_task_ids
 NULL
diff --git a/R/validate_model_data.R b/R/validate_model_data.R
@@ -4,7 +4,7 @@
 #' values depend on other task IDs) to ignore. Columns for such task ids will
 #' contain `NA`s.
 #' If `NULL`, defaults to extracting derived task IDs from hub `task.json`. See
-#' [get_derived_task_ids()] for more details.
+#' [get_hub_derived_task_ids()] for more details.
 #' @inheritParams check_tbl_unique_round_id
 #' @inheritParams validate_model_file
 #' @inheritParams hubData::create_hub_schema
@@ -118,7 +118,7 @@ validate_model_data <- function(hub_path, file_path, round_id_col = NULL,
 
   # Get derived task IDs if not specified
   if (is.null(derived_task_ids)) {
-    derived_task_ids <- get_derived_task_ids(
+    derived_task_ids <- get_hub_derived_task_ids(
       hub_path, round_id
     )
   } else {

diff --git a/man/check_tbl_spl_compound_taskid_set.Rd b/man/check_tbl_spl_compound_taskid_set.Rd
diff --git a/man/check_tbl_spl_compound_tid.Rd b/man/check_tbl_spl_compound_tid.Rd
diff --git a/man/check_tbl_spl_n.Rd b/man/check_tbl_spl_n.Rd
diff --git a/man/check_tbl_spl_non_compound_tid.Rd b/man/check_tbl_spl_non_compound_tid.Rd
diff --git a/man/check_tbl_value_col.Rd b/man/check_tbl_value_col.Rd
diff --git a/man/check_tbl_values.Rd b/man/check_tbl_values.Rd
diff --git a/man/check_tbl_values_required.Rd b/man/check_tbl_values_required.Rd
diff --git a/man/validate_model_data.Rd b/man/validate_model_data.Rd
diff --git a/man/validate_pr.Rd b/man/validate_pr.Rd
diff --git a/man/validate_submission.Rd b/man/validate_submission.Rd
diff --git a/tests/testthat/_snaps/expand_model_out_grid.md b/tests/testthat/_snaps/expand_model_out_grid.md
@@ -890,7 +890,7 @@
 
     Code
       suppressWarnings(expand_model_out_grid(config_tasks = config_tasks, round_id = round_id,
-        output_types = "pmf", derived_task_ids = get_derived_task_ids(hub_path)))
+        output_types = "pmf", derived_task_ids = get_hub_derived_task_ids(hub_path)))
     Output
       # A tibble: 540 x 7
          forecast_date target  horizon target_date location output_type output_type_id

diff --git a/tests/testthat/test-expand_model_out_grid.R b/tests/testthat/test-expand_model_out_grid.R
@@ -745,7 +745,7 @@ test_that("v4 required output type ID values extracted correctly", {
         config_tasks = config_tasks,
         round_id = round_id,
         output_types = "pmf",
-        derived_task_ids = get_derived_task_ids(hub_path)
+        derived_task_ids = get_hub_derived_task_ids(hub_path)
       )
     )
   )