refactor

2DegreesInvesting · Oct 27, 2024 · 7b4668d · 7b4668d
1 parent a73b003
commit 7b4668d
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 13 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -2,7 +2,7 @@
 
 export(add_benchmark_tr_score)
 export(add_thresholds_transition_risk)
-export(add_transition_risk_category)
+export(add_transition_risk_category_at_product_level)
 export(add_transition_risk_score)
 export(best_case_worst_case_transition_risk_profile)
 export(example_emissions_profile_at_product_level)

diff --git a/R/add_transition_risk_category.R → ...ansition_risk_category_at_product_level.R b/R/add_transition_risk_category.R → ...ansition_risk_category_at_product_level.R
@@ -23,9 +23,9 @@
 #'   scenarios
 #' )
 #'
-#' output <- add_transition_risk_category(transition_risk_thresholds)
+#' output <- add_transition_risk_category_at_product_level(transition_risk_thresholds)
 #' output
-add_transition_risk_category <- function(data) {
+add_transition_risk_category_at_product_level <- function(data) {
   check_crucial_cols(data, c(
     col_transition_risk_score(), col_tr_low_threshold(),
     col_tr_high_threshold()

diff --git a/R/transition_risk_profile.R b/R/transition_risk_profile.R
@@ -129,7 +129,7 @@ transition_risk_profile_impl <- function(emissions_profile,
       "benchmark_tr_score",
       "activity_uuid_product_uuid"
     )) |>
-    add_transition_risk_category() |>
+    add_transition_risk_category_at_product_level() |>
     best_case_worst_case_transition_risk_profile() |>
     polish_best_case_worst_case() |>
     polish_best_case_worst_case_transition_risk_profile()

diff --git a/man/add_transition_risk_category.Rd → ...nsition_risk_category_at_product_level.Rd b/man/add_transition_risk_category.Rd → ...nsition_risk_category_at_product_level.Rd
diff --git a/...tthat/test-add_transition_risk_category.R → ...ansition_risk_category_at_product_level.R b/...tthat/test-add_transition_risk_category.R → ...ansition_risk_category_at_product_level.R
@@ -11,15 +11,15 @@ test_that("if input data lacks crucial columns, errors gracefully", {
 
   crucial <- col_transition_risk_score()
   bad <- select(input_data, -all_of(crucial))
-  expect_error(add_transition_risk_category(bad), crucial)
+  expect_error(add_transition_risk_category_at_product_level(bad), crucial)
 
   crucial <- col_tr_low_threshold()
   bad <- select(input_data, -all_of(crucial))
-  expect_error(add_transition_risk_category(bad), crucial)
+  expect_error(add_transition_risk_category_at_product_level(bad), crucial)
 
   crucial <- col_tr_high_threshold()
   bad <- select(input_data, -all_of(crucial))
-  expect_error(add_transition_risk_category(bad), crucial)
+  expect_error(add_transition_risk_category_at_product_level(bad), crucial)
 })
 
 test_that("if `transition_risk_category` column has only NAs, then class of the column is `character`", {
@@ -34,7 +34,7 @@ test_that("if `transition_risk_category` column has only NAs, then class of the
     all_activities_scenario_sectors,
     scenarios
   ) |>
-    add_transition_risk_category()
+    add_transition_risk_category_at_product_level()
 
   expected_class <- "character"
   expect_equal(class(output$transition_risk_category), expected_class)