New readNewClimate.R

.buildlibrary

@@ -1,4 +1,4 @@
-ValidationKey: '43050380'
+ValidationKey: '43465680'
 AcceptedWarnings:
 - Invalid URL: .*
 - 'Warning: package ''.*'' was built under R version'

CITATION.cff

@@ -2,8 +2,8 @@ cff-version: 1.2.0
 message: If you use this software, please cite it using the metadata from this file.
 type: software
 title: 'mrremind: MadRat REMIND Input Data Package'
-version: 0.214.0
-date-released: '2025-01-29'
+version: 0.216.0
+date-released: '2025-02-04'
 abstract: The mrremind packages contains data preprocessing for the REMIND model.
 authors:
 - family-names: Baumstark

DESCRIPTION

@@ -1,8 +1,8 @@
 Type: Package
 Package: mrremind
 Title: MadRat REMIND Input Data Package
-Version: 0.214.0
-Date: 2025-01-29
+Version: 0.216.0
+Date: 2025-02-04
 Authors@R: c(
     person("Lavinia", "Baumstark", , "lavinia@pik-potsdam.de", role = c("aut", "cre")),
     person("Renato", "Rodrigues", role = "aut"),

R/readNewClimate.R

@@ -0,0 +1,94 @@
+#' Reads NPI policy database with technology capacity target from the Policy data base (v4 August 2024)
+#' by PBL that translate the high impact policies of https://climatepolicydatabase.org/.
+#' @description Reads excel sheet with NPi (National Policies Implemented)
+#' data on different policy targets (capacity) with different variations:
+#' unconditional for minimal and conditionnal for maximum targets.
+#' NPI targets only include targets that are based on implemented policy instruments.
+#' @details Country name is ISO coded. Capacity/Additional Capacity targets are in GW.
+#' @return  magpie object
+#' @author  Rahel Mandaroux, Léa Hayez, Falk Benke
+#' @param subtype Capacity_YYYY_cond or Emissions_YYYY_cond (or uncond)
+#' @importFrom readxl read_xlsx
+#' @importFrom dplyr select
+
+readNewClimate <- function(subtype) {
+
+
+  if (grepl("2025", subtype, fixed = TRUE)) { # keep structure to compare when new versions (NPi target updates)
+    NPIfile <- "NPi_2025-02-03.xlsx"
+  } else {
+    NPIfile <- "NPi_2025-02-03.xlsx"
+    if (!grepl("2025", subtype, fixed = TRUE)) {
+      warning("\nNo data for year in ", subtype, " available. Choose default: ", NPIfile)
+    }
+  }
+
+  if (grepl("Capacity", subtype, fixed = TRUE)) {
+    # Capacity/Additional Capacity targets are in GW.
+    NPI <- read_excel(NPIfile, sheet = "Capacity_target_PBL_2025",
+                      col_types = c("text", "skip", "numeric", "text", "text", "numeric",
+                                    "numeric", "numeric", "numeric", "numeric", "numeric", "numeric",
+                                    "numeric", "numeric", "numeric", "numeric", "numeric", "skip", "skip", "skip"))
+    x <- as.magpie(NPI, spatial = 1, temporal = 2, datacol = 3)
+  } else if (grepl("Emissions", subtype, fixed = TRUE)) {
+    input <- read_xlsx(NPIfile, sheet = "EmissionTargets", skip = 3, na = c("?", ""))
+    # select the relevant columns to work upon
+    input2 <- select(input, 2, 7:14)
+    # rename columns
+    colnames(input2) <- c("ISO_Code", "Reference_Year", "BAU_or_Reference_emissions_in_MtCO2e", "Target_Year",
+                          "Type", "Unconditional", "Conditional", "Uncond2", "Cond2")
+    # if no entry in first two quantitative columns, use data from 3rd and 4th
+    bothcolumns <- input2$ISO_Code[(!is.na(input2$Unconditional) & !is.na(input2$Uncond2)) |
+                                     (!is.na(input2$Conditional) & !is.na(input2$Cond2))]
+    if (length(bothcolumns) > 0) {
+      warning("readNewClimate with subtype=", subtype, " has values in more than one Uncond/Cond column in: ",
+              paste(bothcolumns, collapse = ", "))
+    }
+    # check consistency of Type. Note: this has to be identical to the definition in calcEmiTarget.R
+    allowedType <- c("GHG-Absolute", "GHG", "GHG/GDP", "CO2/GDP", "GHG-fixed-total", "GHG/CAP")
+    if (!all(input2$Type %in% allowedType)) {
+      warning("Unknown data type used in ", NPIfile, ": ",
+              paste(unique(input2$Type)[!unique(input2$Type) %in% allowedType], collapse = ", "),
+              ". Please use: ", paste(allowedType, collapse = " or "), ".")
+    }
+
+    # drop extra columns
+    input2[is.na(input2$Unconditional), ]$Unconditional <- input2[is.na(input2$Unconditional), ]$Uncond2
+    input2[is.na(input2$Conditional), ]$Conditional <- input2[is.na(input2$Conditional), ]$Cond2
+    input2$Uncond2 <- NULL
+    input2$Cond2 <- NULL
+
+    # if conditional is empty, fill with unconditional
+    input2[is.na(input2$Conditional), ]$Conditional <- input2[is.na(input2$Conditional), ]$Unconditional
+
+    # in case a country has two or more types of targets for same year, use GHG-Absolute targets
+    # note: the only remaining country in 2021 is MGD Madagascar based on its 2016 submission
+    input2 <- input2[!(input2$ISO_Code %in% input2[duplicated(input2[c(1, 4)]), ]$ISO_Code &
+                         input2$Target_Year %in% input2[duplicated(input2[c(1, 4)]), ]$Target_Year &
+                         input2$Type != "GHG-Absolute"), ]
+
+    # check whether conditional is more stringent than unconditional
+    condTrumpsUncond <- (input2$Conditional <= input2$Unconditional) | is.na(input2$Unconditional)
+    if (any(!condTrumpsUncond)) {
+      warning("readNewClimate with subtype=", subtype, ": unconditional target more stringent than conditional in: ",
+              paste(input2$ISO_Code[!condTrumpsUncond], collapse = ", "))
+    }
+
+    # warning if emission changes have no reference year or BAU reference
+    ref4change <- input2$ISO_Code[input2$Reference_Year %in% c("no", NA) &
+                                    input2$Type %in% c("GHG", "CO2/GDP", "GHG/GDP", "GHG-Absolute")]
+    if (length(ref4change) > 0) {
+      warning("readNewClimate with subtype=", subtype, " has no entry in column reference year in:",
+              paste(ref4change, collapse = ", "))
+    }
+    # as magclass can only cover numerical values well, transform: in column 2 BAU into -1, and Type into number based on allowedType
+    input2[2] <- as.numeric(unlist(rapply(input2[2], function(x) 
+      ifelse(x == "BAU", -1, ifelse(x == "no", -2, x)), how = "replace")))
+    input2[5] <- as.numeric(unlist(rapply(input2[5], function(x) match(x, allowedType), how = "replace")))
+    # sort with c(1,4,2,3,5,6,7) to get region into first and years into second column
+    x <- as.magpie(input2[c(1, 4, 2, 3, 5, 6, 7)], spatial = 1, temporal = 2, datacol = 3)
+  } else {
+    stop("Incorrect subtype, please use Capacity_YYYY_cond or Emissions_YYYY_cond (or uncond).")
+  } 
+  return(x)
+}

README.md

@@ -1,6 +1,6 @@
 # MadRat REMIND Input Data Package
 
-R package **mrremind**, version **0.214.0**
+R package **mrremind**, version **0.216.0**
 
 [![CRAN status](https://www.r-pkg.org/badges/version/mrremind)](https://cran.r-project.org/package=mrremind) [![R build status](https://github.com/pik-piam/mrremind/workflows/check/badge.svg)](https://github.com/pik-piam/mrremind/actions) [![codecov](https://codecov.io/gh/pik-piam/mrremind/branch/master/graph/badge.svg)](https://app.codecov.io/gh/pik-piam/mrremind) [![r-universe](https://pik-piam.r-universe.dev/badges/mrremind)](https://pik-piam.r-universe.dev/builds)
 
@@ -39,17 +39,17 @@ In case of questions / problems please contact Lavinia Baumstark <lavinia@pik-po
 
 To cite package **mrremind** in publications use:
 
-Baumstark L, Rodrigues R, Levesque A, Oeser J, Bertram C, Mouratiadou I, Malik A, Schreyer F, Soergel B, Rottoli M, Mishra A, Dirnaichner A, Pehl M, Giannousakis A, Klein D, Strefler J, Feldhaus L, Brecha R, Rauner S, Dietrich J, Bi S, Benke F, Weigmann P, Richters O, Hasse R, Fuchs S, Mandaroux R, Koch J (2025). "mrremind: MadRat REMIND Input Data Package." Version: 0.214.0, <https://github.com/pik-piam/mrremind>.
+Baumstark L, Rodrigues R, Levesque A, Oeser J, Bertram C, Mouratiadou I, Malik A, Schreyer F, Soergel B, Rottoli M, Mishra A, Dirnaichner A, Pehl M, Giannousakis A, Klein D, Strefler J, Feldhaus L, Brecha R, Rauner S, Dietrich J, Bi S, Benke F, Weigmann P, Richters O, Hasse R, Fuchs S, Mandaroux R, Koch J (2025). "mrremind: MadRat REMIND Input Data Package." Version: 0.216.0, <https://github.com/pik-piam/mrremind>.
 
 A BibTeX entry for LaTeX users is
 
  ```latex
 @Misc{,
   title = {mrremind: MadRat REMIND Input Data Package},
   author = {Lavinia Baumstark and Renato Rodrigues and Antoine Levesque and Julian Oeser and Christoph Bertram and Ioanna Mouratiadou and Aman Malik and Felix Schreyer and Bjoern Soergel and Marianna Rottoli and Abhijeet Mishra and Alois Dirnaichner and Michaja Pehl and Anastasis Giannousakis and David Klein and Jessica Strefler and Lukas Feldhaus and Regina Brecha and Sebastian Rauner and Jan Philipp Dietrich and Stephen Bi and Falk Benke and Pascal Weigmann and Oliver Richters and Robin Hasse and Sophie Fuchs and Rahel Mandaroux and Johannes Koch},
-  date = {2025-01-29},
+  date = {2025-02-04},
   year = {2025},
   url = {https://github.com/pik-piam/mrremind},
-  note = {Version: 0.214.0},
+  note = {Version: 0.216.0},
 }
 ```