change stop_if_not_*() function names to affirmative assert_*() names (…

…#230)
RMI-PACTA · Nov 12, 2024 · befaeb9 · befaeb9
1 parent cfddd2d
commit befaeb9
Show file tree

Hide file tree

Showing 18 changed files with 244 additions and 243 deletions.
diff --git a/R/aggregate_alignment_loanbook_exposure.R b/R/aggregate_alignment_loanbook_exposure.R
@@ -219,7 +219,7 @@ validate_input_data_aggregate_alignment_loanbook_exposure <- function(data,
                                                                       matched,
                                                                       group_vars,
                                                                       .by = NULL) {
-  stop_if_not_expected_columns(
+  assert_expected_columns(
     data = data,
     cols = c(
       group_vars,
@@ -230,7 +230,7 @@ validate_input_data_aggregate_alignment_loanbook_exposure <- function(data,
     )
   )
 
-  stop_if_not_expected_columns(
+  assert_expected_columns(
     data = matched,
     cols = c(
       "id_loan",

diff --git a/R/analyse.R b/R/analyse.R
@@ -23,8 +23,8 @@ analyse <- function(config) {
 
   dir_analysis <- get_dir_analysis(config)
 
-  stop_if_not_length(dir_analysis, 1L)
-  stop_if_not_inherits(dir_analysis, "character")
+  assert_length(dir_analysis, 1L)
+  assert_inherits(dir_analysis, "character")
 
   if (dir.exists(dir_analysis)) {
     ask_for_permission(

diff --git a/R/stop_if_.R → R/assert_.R b/R/stop_if_.R → R/assert_.R
@@ -1,4 +1,4 @@
-#' stop_if_not_inherits
+#' assert_inherits
 #'
 #' @param x an object to be checked
 #' @param cls a string defining the expected object class
@@ -7,7 +7,7 @@
 #'
 #' @noRd
 
-stop_if_not_inherits <- function(x, cls) {
+assert_inherits <- function(x, cls) {
   if (isFALSE(inherits(x, cls))) {
     arg <- deparse(substitute(x))
     cli::cli_abort(
@@ -21,7 +21,7 @@ stop_if_not_inherits <- function(x, cls) {
 }
 
 
-#' stop_if_not_length
+#' assert_length
 #'
 #' @param x an object to be checked
 #' @param len an integer defining the expected length of the object
@@ -30,7 +30,7 @@ stop_if_not_inherits <- function(x, cls) {
 #'
 #' @noRd
 
-stop_if_not_length <- function(x, len) {
+assert_length <- function(x, len) {
   if (length(x) != len) {
     arg <- deparse(substitute(x))
     cli::cli_abort(
@@ -44,7 +44,7 @@ stop_if_not_length <- function(x, len) {
 }
 
 
-#' stop_if_dir_not_found
+#' assert_dir_exists
 #'
 #' @param path a string defining the path to a directory
 #' @param desc a string describing the type of directory to be added to the
@@ -54,7 +54,7 @@ stop_if_not_length <- function(x, len) {
 #'
 #' @noRd
 
-stop_if_dir_not_found <- function(path, desc = NULL) {
+assert_dir_exists <- function(path, desc = NULL) {
   if (isFALSE(dir.exists(path))) {
     if (is.null(desc)) {
       msg <- "Directory not found at path:"
@@ -73,7 +73,7 @@ stop_if_dir_not_found <- function(path, desc = NULL) {
 }
 
 
-#' stop_if_file_not_found
+#' assert_file_exists
 #'
 #' @param path a string defining the path to a file
 #' @param desc a string describing the type of file to be added to the error msg
@@ -82,7 +82,7 @@ stop_if_dir_not_found <- function(path, desc = NULL) {
 #'
 #' @noRd
 
-stop_if_file_not_found <- function(path, desc = NULL) {
+assert_file_exists <- function(path, desc = NULL) {
   if (isFALSE(file.exists(path))) {
     if (is.null(desc)) {
       msg <- "File not found at path:"
@@ -101,7 +101,7 @@ stop_if_file_not_found <- function(path, desc = NULL) {
 }
 
 
-#' stop_if_sheet_not_found
+#' assert_sheet_exists
 #'
 #' @param sheet a string defining the name of a sheet
 #' @param path a string defining the path to a XLS/X file
@@ -110,7 +110,7 @@ stop_if_file_not_found <- function(path, desc = NULL) {
 #'
 #' @noRd
 
-stop_if_sheet_not_found <- function(sheet, path) {
+assert_sheet_exists <- function(sheet, path) {
   if (isFALSE(sheet %in% readxl::excel_sheets(path))) {
     cli::cli_abort(
       message = c(
@@ -124,7 +124,7 @@ stop_if_sheet_not_found <- function(sheet, path) {
 }
 
 
-#' stop_if_not_expected_columns
+#' assert_expected_columns
 #'
 #' @param data a data frame to be checked
 #' @param cols a vector of expected column names
@@ -134,7 +134,7 @@ stop_if_sheet_not_found <- function(sheet, path) {
 #'
 #' @noRd
 
-stop_if_not_expected_columns <- function(data, cols, desc = NULL) {
+assert_expected_columns <- function(data, cols, desc = NULL) {
   if (isFALSE(all(cols %in% names(data)))) {
     if (is.null(desc)) {
       msg <- "Data does not contain all of the expected columns."
@@ -153,7 +153,7 @@ stop_if_not_expected_columns <- function(data, cols, desc = NULL) {
 }
 
 
-#' stop_if_no_files_found
+#' assert_any_file_exists
 #'
 #' @param files a vector of files found
 #' @param dir a dir where files were not found
@@ -165,7 +165,7 @@ stop_if_not_expected_columns <- function(data, cols, desc = NULL) {
 #'
 #' @noRd
 
-stop_if_no_files_found <- function(files, dir, dir_param, desc) {
+assert_any_file_exists <- function(files, dir, dir_param, desc) {
   if (length(files) == 0) {
     cli::cli_abort(
       message = c(
@@ -179,15 +179,15 @@ stop_if_no_files_found <- function(files, dir, dir_param, desc) {
 }
 
 
-#' stop_if_sector_split_not_one
+#' assert_sector_split_is_one
 #'
 #' @param data a data frame to be checked
 #'
 #' @return `NULL` invisibly or an error
 #'
 #' @noRd
 
-stop_if_sector_split_not_one <- function(data) {
+assert_sector_split_is_one <- function(data) {
   check_sector_split <-
     dplyr::summarise(
       data,

diff --git a/R/calculate_company_alignment_metric.R b/R/calculate_company_alignment_metric.R
@@ -592,7 +592,7 @@ validate_input_args_calculate_company_tech_deviation <- function(scenario_source
 
 validate_input_data_calculate_company_tech_deviation <- function(data,
                                                                  technology_direction) {
-  stop_if_not_expected_columns(
+  assert_expected_columns(
     data = data,
     cols = c(
       "sector", "technology", "year", "region", "scenario_source", "name_abcd",
@@ -601,7 +601,7 @@ validate_input_data_calculate_company_tech_deviation <- function(data,
     )
   )
 
-  stop_if_not_expected_columns(
+  assert_expected_columns(
     data = technology_direction,
     cols = c(
       "scenario_source", "scenario", "sector", "technology", "region",
@@ -656,7 +656,7 @@ validate_input_args_calculate_company_aggregate_alignment_tms <- function(scenar
 
 validate_input_data_calculate_company_aggregate_alignment_tms <- function(data,
                                                                           scenario) {
-  stop_if_not_expected_columns(
+  assert_expected_columns(
     data = data,
     cols = c(
       "sector", "technology", "year", "region", "scenario_source", "name_abcd",
@@ -735,7 +735,7 @@ validate_input_args_calculate_company_aggregate_alignment_sda <- function(scenar
 
 
 validate_input_data_calculate_company_aggregate_alignment_sda <- function(data) {
-  stop_if_not_expected_columns(
+  assert_expected_columns(
     data = data,
     cols = c(
       "sector", "year", "region", "scenario_source", "name_abcd",

diff --git a/R/helper_functions.R b/R/helper_functions.R
@@ -77,8 +77,8 @@ apply_sector_split_to_loans <- function(data,
 
 check_and_prepare_by_group <- function(by_group) {
   if (!is.null(by_group)) {
-    stop_if_not_inherits(by_group, "character")
-    stop_if_not_length(by_group, 1)
+    assert_inherits(by_group, "character")
+    assert_length(by_group, 1)
     if (by_group == "NULL") {
       by_group <- NULL
     } else {

diff --git a/R/match_loanbooks.R b/R/match_loanbooks.R
@@ -51,47 +51,47 @@ match_loanbooks <- function(config) {
   }
 
   # validate config values----
-  stop_if_not_length(dir_loanbooks, 1L)
-  stop_if_not_inherits(dir_loanbooks, "character")
-  stop_if_dir_not_found(dir_loanbooks, desc = "Input - loanbooks")
+  assert_length(dir_loanbooks, 1L)
+  assert_inherits(dir_loanbooks, "character")
+  assert_dir_exists(dir_loanbooks, desc = "Input - loanbooks")
 
-  stop_if_not_length(dir_prepared_abcd, 1L)
-  stop_if_not_inherits(dir_prepared_abcd, "character")
-  stop_if_dir_not_found(dir_prepared_abcd, desc = "Output - prepare ABCD")
-  stop_if_file_not_found(file.path(dir_prepared_abcd, "abcd_final.csv"), desc = "ABCD final")
+  assert_length(dir_prepared_abcd, 1L)
+  assert_inherits(dir_prepared_abcd, "character")
+  assert_dir_exists(dir_prepared_abcd, desc = "Output - prepare ABCD")
+  assert_file_exists(file.path(dir_prepared_abcd, "abcd_final.csv"), desc = "ABCD final")
 
-  stop_if_not_length(dir_matched_loanbooks, 1L)
-  stop_if_not_inherits(dir_matched_loanbooks, "character")
-  stop_if_dir_not_found(dir_matched_loanbooks, desc = "Output - Matched loanbooks")
+  assert_length(dir_matched_loanbooks, 1L)
+  assert_inherits(dir_matched_loanbooks, "character")
+  assert_dir_exists(dir_matched_loanbooks, desc = "Output - Matched loanbooks")
 
-  stop_if_not_length(matching_by_sector, 1L)
-  stop_if_not_inherits(matching_by_sector, "logical")
+  assert_length(matching_by_sector, 1L)
+  assert_inherits(matching_by_sector, "logical")
 
-  stop_if_not_length(matching_min_score, 1L)
-  stop_if_not_inherits(matching_min_score, "numeric")
+  assert_length(matching_min_score, 1L)
+  assert_inherits(matching_min_score, "numeric")
 
-  stop_if_not_length(matching_method, 1L)
-  stop_if_not_inherits(matching_method, "character")
+  assert_length(matching_method, 1L)
+  assert_inherits(matching_method, "character")
 
-  stop_if_not_length(matching_p, 1L)
-  stop_if_not_inherits(matching_p, "numeric")
+  assert_length(matching_p, 1L)
+  assert_inherits(matching_p, "numeric")
 
   # TODO: check for data.frame
-  # stop_if_not_length(matching_overwrite, 1L)
-  # stop_if_not_inherits(matching_overwrite, "numeric")
+  # assert_length(matching_overwrite, 1L)
+  # assert_inherits(matching_overwrite, "numeric")
   #
   # TODO: check for join_object
-  # stop_if_not_length(matching_join_id, 1L)
-  # stop_if_not_inherits(matching_join_id, "numeric")
+  # assert_length(matching_join_id, 1L)
+  # assert_inherits(matching_join_id, "numeric")
 
-  stop_if_not_length(matching_use_manual_sector_classification, 1L)
-  stop_if_not_inherits(matching_use_manual_sector_classification, "logical")
+  assert_length(matching_use_manual_sector_classification, 1L)
+  assert_inherits(matching_use_manual_sector_classification, "logical")
 
   # path to manual sector classification only required if boolean TRUE
   if (matching_use_manual_sector_classification) {
-    stop_if_not_length(path_manual_sector_classification, 1L)
-    stop_if_not_inherits(path_manual_sector_classification, "character")
-    stop_if_file_not_found(path_manual_sector_classification, desc = "Manual sector classification")
+    assert_length(path_manual_sector_classification, 1L)
+    assert_inherits(path_manual_sector_classification, "character")
+    assert_file_exists(path_manual_sector_classification, desc = "Manual sector classification")
   }
 
   # load data----
@@ -114,7 +114,7 @@ match_loanbooks <- function(config) {
 
   ## load raw loan books----
   list_raw <- list.files(path = dir_loanbooks, pattern = "[.]csv$")
-  stop_if_no_files_found(list_raw, dir_loanbooks, "dir_input", "raw loan book CSVs")
+  assert_any_file_exists(list_raw, dir_loanbooks, "dir_input", "raw loan book CSVs")
 
   raw_lbk <- readr::read_csv(
     file = file.path(dir_loanbooks, list_raw),