Merge pull request #30 from ahagen-pik/moveSubsidies

move preparation of subsidies data to mrtransport

.buildlibrary

@@ -1,4 +1,4 @@
-ValidationKey: '2027575'
+ValidationKey: '2047752'
 AutocreateReadme: yes
 AcceptedWarnings:
 - '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: 'mrtransport: Input data generation for the EDGE-Transport model'
-version: 0.10.1
-date-released: '2024-12-18'
+version: 0.10.2
+date-released: '2024-12-19'
 abstract: The mrtransport package contains data preprocessing for the EDGE-Transport
   model.
 authors:

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: mrtransport
 Title: Input data generation for the EDGE-Transport model
-Version: 0.10.1
+Version: 0.10.2
 Authors@R: c(
     person("Johanna", "Hoppe", , "[email protected]", role = c("aut", "cre"),
            comment = c(ORCID = "0009-0004-6753-5090")),
@@ -33,4 +33,4 @@ Imports:
     tidyselect,
     utils,
     zoo
-Date: 2024-12-18
+Date: 2024-12-19

NAMESPACE

@@ -15,6 +15,7 @@ export(toolPrepareEurostatEnergyCountryDataSheets)
 export(toolPrepareGCAM)
 export(toolPreparePSI)
 export(toolPreparePurchasePriceSubsidies)
+export(toolPrepareTransportSubsidies)
 export(toolPrepareUCD)
 import(GDPuc)
 import(data.table)

R/toolPrepareTransportSubsidies.R

@@ -0,0 +1,40 @@
+#' Prepare subsidies data
+#' @param helpers list containg several helpers used throughout the model.
+#'          It includes dtTimeRes, a data.table containing the temporal
+#'          resolution for different univocalNames
+#' @returns list of data.tables containing mrremind input data
+#' @importFrom rmndt magpie2dt
+#' @export
+
+toolPrepareTransportSubsidies <- function(helpers) {
+  # bind variables locally to prevent NSE notes in R CMD CHECK
+  period <- value <- subsectorL3 <- variable <- unit <- . <- NULL
+
+  yrs <- unique(helpers$dtTimeRes$period)
+
+  subsidies <- magpie2dt(readSource(type = "TransportSubsidies"))
+  setnames(subsidies, "variable", "technology")
+  # average between legal and private entities
+  subsidies <- subsidies[, .(value = mean(value)), by = c("region", "period", "technology")]
+  subsidies[, value := -value] # count subsidies negative
+  completeSub <- unique(subsidies[, c("region", "technology")])[, temporal := "all"]
+  temporal <- data.table(period = yrs)[, temporal := "all"]
+  completeSub <- merge(completeSub, temporal, by = "temporal", allow.cartesian = TRUE)[, temporal := NULL]
+  subsidies <- merge(subsidies, completeSub, all.y = TRUE, by = c("region", "technology", "period"))
+
+  ## year where complete phase-out incentives occurs
+  yearOut <- 2030
+  ## attribute first (to the countries that have them) the same incentives value until the phase out year
+  subsidies[, value := ifelse(period >= 2020 & period <= yearOut, value[period == 2020], 0),
+            by = c("region", "technology")]
+
+  # map on decision tree, apply only on 4 wheelers
+  subsidies <- merge(unique(helpers$decisionTree[subsectorL3 == "trn_pass_road_LDV_4W",
+                                                 c("region", "univocalName", "technology")]), subsidies,
+                     by = c("region", "technology"), all.x = TRUE, allow.cartesian = TRUE)
+  monUnit <- gsub(".*?(\\d{4}).*", "US$\\1", mrdrivers::toolGetUnitDollar())
+  subsidies <- subsidies[!is.na(value)][, variable := "Capital costs subsidy"][, unit := paste0(monUnit, "/veh")]
+  # Q: How to include phase out of the incentives? Is that needed at all?
+
+  return(subsidies)
+}

README.md

@@ -1,6 +1,6 @@
 # Input data generation for the EDGE-Transport model
 
-R package **mrtransport**, version **0.10.1**
+R package **mrtransport**, version **0.10.2**
 
 [![CRAN status](https://www.r-pkg.org/badges/version/mrtransport)](https://cran.r-project.org/package=mrtransport) [![R build status](https://github.com/pik-piam/mrtransport/workflows/check/badge.svg)](https://github.com/pik-piam/mrtransport/actions) [![codecov](https://codecov.io/gh/pik-piam/mrtransport/branch/master/graph/badge.svg)](https://app.codecov.io/gh/pik-piam/mrtransport) [![r-universe](https://pik-piam.r-universe.dev/badges/mrtransport)](https://pik-piam.r-universe.dev/builds)
 
@@ -39,15 +39,17 @@ In case of questions / problems please contact Johanna Hoppe <johanna.hoppe@pik-
 
 To cite package **mrtransport** in publications use:
 
-Hoppe J, Muessel J, Dirnaichner A (2024). "mrtransport: Input data generation for the EDGE-Transport model - Version 0.10.1."
+Hoppe J, Muessel J, Dirnaichner A (2024). "mrtransport: Input data generation for the EDGE-Transport model." Version: 0.10.2, <https://github.com/pik-piam/mrtransport>.
 
 A BibTeX entry for LaTeX users is
 
  ```latex
 @Misc{,
-  title = {mrtransport: Input data generation for the EDGE-Transport model - Version 0.10.1},
+  title = {mrtransport: Input data generation for the EDGE-Transport model},
   author = {Johanna Hoppe and Jarusch Muessel and Alois Dirnaichner},
-  date = {2024-12-18},
+  date = {2024-12-19},
   year = {2024},
+  url = {https://github.com/pik-piam/mrtransport},
+  note = {Version: 0.10.2},
 }
 ```