From cbf1395e5d4a8b446f84e29a969d0892cc4ae2c6 Mon Sep 17 00:00:00 2001 From: Jackson Hoffart Date: Mon, 5 Jun 2023 11:05:25 +0200 Subject: [PATCH 01/10] document increasing_or_decreasing argument --- R/target_market_share.R | 56 ++++++++++++++++++++++++++++------------- 1 file changed, 38 insertions(+), 18 deletions(-) diff --git a/R/target_market_share.R b/R/target_market_share.R index fcf14911..601af6d6 100644 --- a/R/target_market_share.R +++ b/R/target_market_share.R @@ -19,9 +19,12 @@ #' @param weight_production Logical vector of length 1. `TRUE` defaults to #' outputting production, weighted by relative loan-size. Set to `FALSE` to #' output the unweighted production values. +#' @param increasing_or_decreasing A data frame like +#' [r2dii.data::increasing_or_decreasing]. #' @param ald `r lifecycle::badge('superseded')` `ald` has been superseded by #' `abcd`. -#' @param green_or_brown A data frame like [r2dii.data::green_or_brown]. +#' @param green_or_brown `r lifecycle::badge("superseded")` `green_or_brown` has +#' been superseded by `increasing_or_decreasing`. #' #' @return A tibble including the summarized columns `metric`, `production`, #' `technology_share`, `percentage_of_initial_production_by_scope` and @@ -80,8 +83,9 @@ target_market_share <- function(data, use_credit_limit = FALSE, by_company = FALSE, weight_production = TRUE, - green_or_brown = r2dii.data::green_or_brown, - ald = deprecated()) { + increasing_or_decreasing = r2dii.data::increasing_or_decreasing, + ald = deprecated(), + green_or_brown = deprecated()) { stopifnot( is.data.frame(data), is.data.frame(abcd), @@ -101,6 +105,22 @@ target_market_share <- function(data, abcd <- ald } + if (lifecycle::is_present(green_or_brown)) { + lifecycle::deprecate_warn( + "0.3.0", + "target_market_share(green_or_brown)", + "target_market_share(increasing_or_decreasing)" + ) + increasing_or_decreasing <- green_or_brown %>% + dplyr::rename(increasing_or_decreasing = .data$green_or_brown) %>% + mutate( + increasing_or_decreasing = case_when( + increasing_or_decreasing == "green" ~ "increasing", + increasing_or_decreasing == "brown" ~ "decreasing" + ) + ) + } + data <- rename_and_warn_ald_names(data) abcd <- filter_and_warn_na(abcd, "production") @@ -120,7 +140,7 @@ target_market_share <- function(data, abcd, scenario, region_isos, - add_green_technologies = TRUE + add_increasing_technologies = TRUE ) if (nrow(data) == 0) { @@ -160,7 +180,7 @@ target_market_share <- function(data, tmsr_or_smsp <- tmsr_or_smsp() - data <- pick_sms_or_tms_target(data, green_or_brown, tmsr_or_smsp) + data <- pick_sms_or_tms_target(data, increasing_or_decreasing, tmsr_or_smsp) if (nrow(data) == 0) { return(empty_target_market_share_output()) @@ -223,21 +243,21 @@ target_market_share <- function(data, data <- data %>% dplyr::bind_rows(relevant_corporate_economy) - data <- add_percentage_of_initial_production_by_scope(data, green_or_brown, tmsr_or_smsp, by_company) + data <- add_percentage_of_initial_production_by_scope(data, increasing_or_decreasing, tmsr_or_smsp, by_company) data %>% ungroup() } add_percentage_of_initial_production_by_scope <- function(data, - green_or_brown, + increasing_or_decreasing, tmsr_or_smsp, by_company) { data <- data %>% - left_join(green_or_brown, by = c("sector", "technology")) %>% - left_join(tmsr_or_smsp, by = "green_or_brown") %>% + left_join(increasing_or_decreasing, by = c("sector", "technology")) %>% + left_join(tmsr_or_smsp, by = "increasing_or_decreasing") %>% rename(target_name = "which_metric") %>% - select(-all_of("green_or_brown")) + select(-all_of("increasing_or_decreasing")) percent_by_sector_groups <- add_name_abcd_if_by_company( c("sector", "region", "scenario_source", "metric"), @@ -370,26 +390,26 @@ add_name_abcd_if_by_company <- function(list, by_company = FALSE) { list } -pick_sms_or_tms_target <- function(data, green_or_brown, tmsr_or_smsp) { +pick_sms_or_tms_target <- function(data, increasing_or_decreasing, tmsr_or_smsp) { data %>% left_join(tmsr_or_smsp, by = c(target_name = "which_metric")) %>% inner_join( - green_or_brown, + increasing_or_decreasing, by = c( sector_abcd = "sector", technology = "technology", - green_or_brown = "green_or_brown" + increasing_or_decreasing = "increasing_or_decreasing" ) ) %>% - warn_if_has_zero_rows("Joining `r2dii.data::green_or_brown` outputs 0 rows") %>% - select(-all_of(c("target_name", "green_or_brown"))) + warn_if_has_zero_rows("Joining `r2dii.data::increasing_or_decreasing` outputs 0 rows") %>% + select(-all_of(c("target_name", "increasing_or_decreasing"))) } tmsr_or_smsp <- function() { dplyr::tribble( - ~which_metric, ~green_or_brown, - "tmsr_target_production", "brown", - "smsp_target_production", "green" + ~which_metric, ~increasing_or_decreasing, + "tmsr_target_production", "decreasing", + "smsp_target_production", "increasing" ) } From 9029999088021f1701fbef9c137168fb1037bdd3 Mon Sep 17 00:00:00 2001 From: Jackson Hoffart Date: Wed, 5 Jul 2023 09:21:08 +0200 Subject: [PATCH 02/10] namespace dplyr --- R/target_market_share.R | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/R/target_market_share.R b/R/target_market_share.R index 601af6d6..e3584be2 100644 --- a/R/target_market_share.R +++ b/R/target_market_share.R @@ -114,7 +114,7 @@ target_market_share <- function(data, increasing_or_decreasing <- green_or_brown %>% dplyr::rename(increasing_or_decreasing = .data$green_or_brown) %>% mutate( - increasing_or_decreasing = case_when( + increasing_or_decreasing = dplyr::case_when( increasing_or_decreasing == "green" ~ "increasing", increasing_or_decreasing == "brown" ~ "decreasing" ) @@ -140,7 +140,7 @@ target_market_share <- function(data, abcd, scenario, region_isos, - add_increasing_technologies = TRUE + add_green_technologies = TRUE ) if (nrow(data) == 0) { From 71aac14d3c0fc2a3c80ecfc25a231dcbd2d750f7 Mon Sep 17 00:00:00 2001 From: Jackson Hoffart Date: Wed, 5 Jul 2023 09:21:17 +0200 Subject: [PATCH 03/10] document --- man/target_market_share.Rd | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/man/target_market_share.Rd b/man/target_market_share.Rd index 3c4aec84..85358e91 100644 --- a/man/target_market_share.Rd +++ b/man/target_market_share.Rd @@ -12,8 +12,9 @@ target_market_share( use_credit_limit = FALSE, by_company = FALSE, weight_production = TRUE, - green_or_brown = r2dii.data::green_or_brown, - ald = deprecated() + increasing_or_decreasing = r2dii.data::increasing_or_decreasing, + ald = deprecated(), + green_or_brown = deprecated() ) } \arguments{ @@ -37,10 +38,14 @@ the column \code{loan_size_outstanding}. Set to \code{TRUE} to use the column outputting production, weighted by relative loan-size. Set to \code{FALSE} to output the unweighted production values.} -\item{green_or_brown}{A data frame like \link[r2dii.data:green_or_brown]{r2dii.data::green_or_brown}.} +\item{increasing_or_decreasing}{A data frame like +\link[r2dii.data:increasing_or_decreasing]{r2dii.data::increasing_or_decreasing}.} \item{ald}{\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#superseded}{\figure{lifecycle-superseded.svg}{options: alt='[Superseded]'}}}{\strong{[Superseded]}} \code{ald} has been superseded by \code{abcd}.} + +\item{green_or_brown}{\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#superseded}{\figure{lifecycle-superseded.svg}{options: alt='[Superseded]'}}}{\strong{[Superseded]}} \code{green_or_brown} has +been superseded by \code{increasing_or_decreasing}.} } \value{ A tibble including the summarized columns \code{metric}, \code{production}, From 50dbb9f3769f559b574280a285c1a6c5feda4413 Mon Sep 17 00:00:00 2001 From: Jackson Hoffart Date: Wed, 5 Jul 2023 10:21:35 +0200 Subject: [PATCH 04/10] remove green_or_brown in favour of increasing_or_decreasing --- NEWS.md | 2 +- R/target_market_share.R | 21 +-------------------- 2 files changed, 2 insertions(+), 21 deletions(-) diff --git a/NEWS.md b/NEWS.md index 892efb0e..ab9a3962 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,6 +1,6 @@ # r2dii.analysis (development version) -# `target_market_share` gains argument `green_or_brown` (#426). +# `target_market_share` gains argument `increasing_or_decreasing` (#426). # r2dii.analysis 0.2.1 diff --git a/R/target_market_share.R b/R/target_market_share.R index e3584be2..315580ef 100644 --- a/R/target_market_share.R +++ b/R/target_market_share.R @@ -23,8 +23,6 @@ #' [r2dii.data::increasing_or_decreasing]. #' @param ald `r lifecycle::badge('superseded')` `ald` has been superseded by #' `abcd`. -#' @param green_or_brown `r lifecycle::badge("superseded")` `green_or_brown` has -#' been superseded by `increasing_or_decreasing`. #' #' @return A tibble including the summarized columns `metric`, `production`, #' `technology_share`, `percentage_of_initial_production_by_scope` and @@ -84,8 +82,7 @@ target_market_share <- function(data, by_company = FALSE, weight_production = TRUE, increasing_or_decreasing = r2dii.data::increasing_or_decreasing, - ald = deprecated(), - green_or_brown = deprecated()) { + ald = deprecated()) { stopifnot( is.data.frame(data), is.data.frame(abcd), @@ -105,22 +102,6 @@ target_market_share <- function(data, abcd <- ald } - if (lifecycle::is_present(green_or_brown)) { - lifecycle::deprecate_warn( - "0.3.0", - "target_market_share(green_or_brown)", - "target_market_share(increasing_or_decreasing)" - ) - increasing_or_decreasing <- green_or_brown %>% - dplyr::rename(increasing_or_decreasing = .data$green_or_brown) %>% - mutate( - increasing_or_decreasing = dplyr::case_when( - increasing_or_decreasing == "green" ~ "increasing", - increasing_or_decreasing == "brown" ~ "decreasing" - ) - ) - } - data <- rename_and_warn_ald_names(data) abcd <- filter_and_warn_na(abcd, "production") From e708a36eb584830ffff02c3da5b1caf57693f9fb Mon Sep 17 00:00:00 2001 From: Jackson Hoffart Date: Thu, 6 Jul 2023 10:34:08 +0200 Subject: [PATCH 05/10] document --- man/target_market_share.Rd | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/man/target_market_share.Rd b/man/target_market_share.Rd index 85358e91..640d041c 100644 --- a/man/target_market_share.Rd +++ b/man/target_market_share.Rd @@ -13,8 +13,7 @@ target_market_share( by_company = FALSE, weight_production = TRUE, increasing_or_decreasing = r2dii.data::increasing_or_decreasing, - ald = deprecated(), - green_or_brown = deprecated() + ald = deprecated() ) } \arguments{ @@ -43,9 +42,6 @@ output the unweighted production values.} \item{ald}{\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#superseded}{\figure{lifecycle-superseded.svg}{options: alt='[Superseded]'}}}{\strong{[Superseded]}} \code{ald} has been superseded by \code{abcd}.} - -\item{green_or_brown}{\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#superseded}{\figure{lifecycle-superseded.svg}{options: alt='[Superseded]'}}}{\strong{[Superseded]}} \code{green_or_brown} has -been superseded by \code{increasing_or_decreasing}.} } \value{ A tibble including the summarized columns \code{metric}, \code{production}, From 571a876df156da1e8a853fd42dc0d14aa300df4a Mon Sep 17 00:00:00 2001 From: Jackson Hoffart Date: Wed, 19 Jul 2023 13:25:30 +0200 Subject: [PATCH 06/10] remove refrences to g or b in tests --- tests/testthat/test-target_market_share.R | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/tests/testthat/test-target_market_share.R b/tests/testthat/test-target_market_share.R index 5feb89ab..e8f9db87 100644 --- a/tests/testthat/test-target_market_share.R +++ b/tests/testthat/test-target_market_share.R @@ -1045,11 +1045,11 @@ test_that("input with only green technologies, outputs only green technologies test_that("technology_share is calculated per region (#315)", { matched <- fake_matched( id_loan = c("L1", "L2"), - name_abcd = c("green", "brown") + name_abcd = c("increasing", "decreasing") ) abcd <- fake_abcd( - name_company = c("brown", "green"), + name_company = c("decreasing", "increasing"), technology = c("ice", "electric"), plant_location = c("US", "FR"), ) @@ -1085,7 +1085,7 @@ test_that("technology_share is calculated per region (#315)", { ) }) -test_that("input with only brown technologies, outputs both green and brown +test_that("input with only decreasing technologies, outputs both increasing and decreasing technologies (#318)", { scenario <- fake_scenario( year = rep(c(2020, 2025), 2), @@ -1094,14 +1094,14 @@ test_that("input with only brown technologies, outputs both green and brown technology = rep(c("ice", "electric"), each = 2), ) - abcd_brown <- fake_abcd( + abcd_decreasing <- fake_abcd( technology = "ice" ) - # testing that input with only brown techs outputs both green and brown techs + # testing that input with only decreasing techs outputs both increasing and decreasing techs out <- target_market_share( fake_matched(), - abcd_brown, + abcd_decreasing, scenario, region_isos_demo ) From 8dd434563ff29943c98e5aee2f2130a70ee8be70 Mon Sep 17 00:00:00 2001 From: Jackson Hoffart Date: Wed, 19 Jul 2023 13:27:23 +0200 Subject: [PATCH 07/10] use r2dii.data::increasing_or_decreasing --- R/summarize_weighted_production.R | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/R/summarize_weighted_production.R b/R/summarize_weighted_production.R index c2444e4a..32d095ee 100644 --- a/R/summarize_weighted_production.R +++ b/R/summarize_weighted_production.R @@ -254,10 +254,10 @@ add_percent_change <- function(data) { check_zero_initial_production(data) - green_or_brown <- r2dii.data::green_or_brown + increasing_or_decreasing <- r2dii.data::increasing_or_decreasing data %>% - inner_join(green_or_brown, by = c( + inner_join(increasing_or_decreasing, by = c( sector_abcd = "sector", technology = "technology" )) %>% @@ -266,15 +266,15 @@ add_percent_change <- function(data) { group_by(.data$sector_abcd, .data$name_abcd) %>% arrange(.data$name_abcd, .data$year) %>% mutate( - brown_percent_change = + decreasing_percent_change = (.data$production - first(.data$production)) / first(.data$production) * 100, - green_percent_change = (.data$production - first(.data$production)) / + increasing_percent_change = (.data$production - first(.data$production)) / first(.data$sector_production) * 100 ) %>% mutate(percent_change = dplyr::case_when( - green_or_brown == "green" ~ green_percent_change, - green_or_brown == "brown" ~ brown_percent_change + increasing_percent_change == "increasing" ~ increasing_percent_change, + increasing_percent_change == "decreasing" ~ decreasing_percent_change )) %>% select(one_of(c(names(data), "percent_change"))) %>% ungroup() From 5d56c409dbc3b2fa97f029bc85345b0ac03903f5 Mon Sep 17 00:00:00 2001 From: Jackson Hoffart Date: Wed, 19 Jul 2023 13:28:12 +0200 Subject: [PATCH 08/10] remove usage of green_or_brown --- R/join_abcd_scenario.R | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/R/join_abcd_scenario.R b/R/join_abcd_scenario.R index be3991d9..198ee73e 100644 --- a/R/join_abcd_scenario.R +++ b/R/join_abcd_scenario.R @@ -101,9 +101,9 @@ check_portfolio_abcd_scenario <- function(valid_matches, abcd, scenario) { } add_green_technologies_to_abcd <- function(data, scenario) { - green_techs <- r2dii.data::green_or_brown %>% - filter(.data$green_or_brown == "green") %>% - select(-all_of("green_or_brown")) + increasing_techs <- r2dii.data::increasing_or_decreasing %>% + filter(.data$increasing_or_decreasing == "increasing") %>% + select(-all_of("increasing_or_decreasing")) green_techs_in_scenario <- scenario %>% select(all_of(c("sector", "technology"))) %>% From f3744715b5e7e23c7d4955f05a3f7e5f668a065a Mon Sep 17 00:00:00 2001 From: Jackson Hoffart Date: Wed, 19 Jul 2023 13:35:48 +0200 Subject: [PATCH 09/10] prune green_or_brown --- R/join_abcd_scenario.R | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/R/join_abcd_scenario.R b/R/join_abcd_scenario.R index 198ee73e..346bbb4f 100644 --- a/R/join_abcd_scenario.R +++ b/R/join_abcd_scenario.R @@ -105,10 +105,10 @@ add_green_technologies_to_abcd <- function(data, scenario) { filter(.data$increasing_or_decreasing == "increasing") %>% select(-all_of("increasing_or_decreasing")) - green_techs_in_scenario <- scenario %>% + increasing_techs_in_scenario <- scenario %>% select(all_of(c("sector", "technology"))) %>% unique() %>% - inner_join(green_techs, by = c("sector", "technology")) + inner_join(increasing_techs, by = c("sector", "technology")) green_rows_to_add <- data %>% group_by( @@ -119,7 +119,7 @@ add_green_technologies_to_abcd <- function(data, scenario) { .data$is_ultimate_owner ) %>% summarize() %>% - left_join(green_techs_in_scenario, by = "sector") %>% + left_join(increasing_techs_in_scenario, by = "sector") %>% mutate(production = 0) dplyr::bind_rows(data, green_rows_to_add) From 2b8b259f8edc902e49f563925c7a75831f533932 Mon Sep 17 00:00:00 2001 From: Jackson Hoffart Date: Wed, 19 Jul 2023 13:39:21 +0200 Subject: [PATCH 10/10] fix typo --- R/summarize_weighted_production.R | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/R/summarize_weighted_production.R b/R/summarize_weighted_production.R index 32d095ee..b0a5cc82 100644 --- a/R/summarize_weighted_production.R +++ b/R/summarize_weighted_production.R @@ -273,8 +273,8 @@ add_percent_change <- function(data) { first(.data$sector_production) * 100 ) %>% mutate(percent_change = dplyr::case_when( - increasing_percent_change == "increasing" ~ increasing_percent_change, - increasing_percent_change == "decreasing" ~ decreasing_percent_change + increasing_or_decreasing == "increasing" ~ increasing_percent_change, + increasing_or_decreasing == "decreasing" ~ decreasing_percent_change )) %>% select(one_of(c(names(data), "percent_change"))) %>% ungroup()