Export best_case_worst_case_impl function (#322)

* refactor

* refactor

Author: kalashsinghal

NAMESPACE

@@ -1,7 +1,9 @@
 # Generated by roxygen2: do not edit by hand
 
 export(best_case_worst_case_emission_profile)
+export(best_case_worst_case_impl)
 export(best_case_worst_case_sector_profile)
+export(polish_best_case_worst_case)
 export(profile_emissions)
 export(profile_emissions_impl)
 export(profile_emissions_upstream)
@@ -10,6 +12,7 @@ export(profile_sector)
 export(profile_sector_impl)
 export(profile_sector_upstream)
 export(profile_sector_upstream_impl)
+export(rename_with_prefix)
 export(toy_emissions_profile_output)
 export(toy_emissions_profile_upstream_output)
 export(toy_profile_emissions_impl_output)

R/best_case_worst_case_impl.R

@@ -1,3 +1,11 @@
+#' Calculate preliminary best case worst case results
+#'
+#' @param data Dataframe.
+#' @param col_group_by Dataframe column.
+#' @param col_risk Dataframe column.
+#' @param col_rank Dataframe column.
+#' @keywords internal
+#' @export
 best_case_worst_case_impl <- function(data, col_group_by, col_risk, col_rank) {
   data |>
     compute_n_distinct_products() |>

R/example_data.R

@@ -1,3 +1,8 @@
+#' Polish preliminary best case worst case results
+#'
+#' @param data Dataframe.
+#' @keywords internal
+#' @export
 polish_best_case_worst_case <- function(data) {
   data |>
     select(-all_of(c(
@@ -9,6 +14,13 @@ polish_best_case_worst_case <- function(data) {
     distinct()
 }
 
+#' Rename using prefix
+#'
+#' @param data Dataframe.
+#' @param prefix String.
+#' @param match String.
+#' @keywords internal
+#' @export
 rename_with_prefix <- function(data, prefix, match = ".") {
   rename_with(data, ~ paste0(prefix, .x), .cols = matches(match))
 }
@@ -22,15 +34,6 @@ polish_best_case_worst_case_emissions_profile <- function(data) {
     ))
 }
 
-polish_best_case_worst_case_transition_risk_profile <- function(data) {
-  data |>
-    rename_with_prefix("transition_risk_profile_", match = c(
-      "^best_case$",
-      "^worst_case$",
-      "^equal_weight$"
-    ))
-}
-
 polish_best_case_worst_case_sector_profile <- function(data) {
   data |>
     rename_with_prefix("sector_profile_", match = c(

R/polish_best_case_worst_case.R

@@ -55,3 +55,26 @@ best_case_worst_case_emission_profile_sample <- function(companies_id = "any",
     emission_profile = emission_profile
   ))
 }
+
+example_best_case_worst_case_profile_ranking_product_level <- example_data_factory(
+  # styler: off
+  tribble(
+    ~companies_id, ~ep_product, ~benchmark, ~emission_profile, ~profile_ranking,
+    "any",       "one",      "all",             "low",              1.0,
+    "any",       "two",      "all",          "medium",              2.0,
+    "any",     "three",      "all",            "high",              3.0
+  )
+  # styler: on
+)
+
+example_best_case_worst_case_reduction_targets_product_level <- example_data_factory(
+  # styler: off
+  tribble(
+    ~companies_id, ~ep_product,  ~scenario_year, ~sector_profile, ~reduction_targets,
+    "any",       "one", "1.5C RPS_2030",           "low",                1.0,
+    "any",       "two", "1.5C RPS_2030",        "medium",                2.0,
+    "any",     "three", "1.5C RPS_2030",          "high",                3.0
+  )
+  # styler: on
+)
+