Merge pull request #176 from Loisel/v0.17.0

Fix code check issues, load factor bug, version bump.

.Rbuildignore

@@ -9,3 +9,6 @@
 ^TAGS
 ^workflow$
 ^\.git$
+^.lintr$
+^tests/.lintr$
+^vignettes/.lintr$

.buildlibrary

@@ -1,4 +1,4 @@
-ValidationKey: '3065600'
+ValidationKey: '3260090'
 AutocreateReadme: yes
 AcceptedWarnings:
 - 'Warning: package ''.*'' was built under R version'

.pre-commit-config.yaml

@@ -3,7 +3,7 @@
 exclude: '^tests/testthat/_snaps/.*$'
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
- rev: v4.2.0
+ rev: v4.3.0
  hooks:
  - id: check-case-conflict
  - id: check-json

.zenodo.json

@@ -1,6 +1,6 @@
 {
  "title": "edgeTransport: Prepare EDGE Transport Data for the REMIND model",
- "version": "0.16.0",
+ "version": "0.17.0",
  "description": "<p>EDGE-T is a fork of the GCAM transport module https://jgcri.github.io/gcam-doc/energy.html#transportation with a high level of detail in its representation of technological and modal options. It is a partial equilibrium model with a nested multinomial logit structure and relies on the modified logit formulation. Most of the sources are not publicly available. PIK-internal users can find the sources in the distributed file system in the folder `/p/projects/rd3mod/inputdata/sources/EDGE-Transport-Standalone`.<\/p>",
  "creators": [
  {

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: edgeTransport
 Title: Prepare EDGE Transport Data for the REMIND model
-Version: 0.16.0
+Version: 0.17.0
 Authors@R: c(
  person("Alois", "Dirnaichner", email = "[email protected]", role = c("aut", "cre")),
  person("Marianna", "Rottoli", email = "[email protected]", role = "aut"))
@@ -13,7 +13,7 @@ Encoding: UTF-8
 LazyData: true
 RoxygenNote: 7.2.0
 VignetteBuilder: knitr
-Date: 2022-06-17
+Date: 2022-07-04
 Config/testthat/edition: 3
 Imports:
  rmndt,
@@ -23,9 +23,6 @@ Imports:
  rootSolve,
  madrat,
  ggplot2,
- luplot,
- lusweave,
- mip,
  quitte,
  zoo,
  magrittr,

NAMESPACE

@@ -7,22 +7,18 @@ export(calcgenerateEDGEdata)
 export(calculate_capCosts)
 export(calculate_logit_inconv_endog)
 export(collectScens)
-export(compScenEDGET)
 export(compareOutputs)
 export(compareScenarios_EDGET)
 export(createRDS)
 export(generateEDGEdata)
 export(loadInputData)
 export(lvl2_demandReg)
-export(lvl2_generate_plotdata)
 export(merge_prices)
 export(prepare4REMIND)
 export(readREMINDdemand)
 export(reportEDGETransport2)
 export(shares_intensity_and_demand)
 import(data.table)
-import(ggplot2)
-import(mip)
 import(rmndt)
 importFrom(data.table,CJ)
 importFrom(data.table,copy)
@@ -33,32 +29,31 @@ importFrom(data.table,rbindlist)
 importFrom(data.table,shift)
 importFrom(gdx,readGDX)
 importFrom(gdxdt,readgdx)
+importFrom(ggplot2,aes)
+importFrom(ggplot2,facet_wrap)
+importFrom(ggplot2,geom_line)
+importFrom(ggplot2,ggplot)
+importFrom(ggplot2,labs)
 importFrom(grDevices,dev.off)
 importFrom(grDevices,pdf)
 importFrom(graphics,plot.new)
 importFrom(graphics,text)
-importFrom(luplot,magpie2ggplot2)
-importFrom(lusweave,swclose)
-importFrom(lusweave,swfigure)
-importFrom(lusweave,swlatex)
-importFrom(lusweave,swopen)
 importFrom(madrat,calcOutput)
 importFrom(madrat,readSource)
-importFrom(magclass,"getNames<-")
 importFrom(magclass,"getSets<-")
-importFrom(magclass,add_dimension)
+importFrom(magclass,as.magpie)
 importFrom(magclass,dimSums)
+importFrom(magclass,getItems)
 importFrom(magclass,getNames)
-importFrom(magclass,getRegions)
 importFrom(magclass,getSets)
 importFrom(magclass,getYears)
 importFrom(magclass,lowpass)
 importFrom(magclass,mbind)
-importFrom(magclass,new.magpie)
-importFrom(magclass,read.report)
-importFrom(magclass,setNames)
+importFrom(magclass,mselect)
 importFrom(magclass,time_interpolate)
+importFrom(magrittr,"%>%")
 importFrom(magrittr,`%>%`)
+importFrom(quitte,aggregate_map)
 importFrom(quitte,as.quitte)
 importFrom(quitte,write.mif)
 importFrom(readxl,read_excel)

R/helpers.R

@@ -48,11 +48,12 @@ collectScens <- function(scen_folder, output_folder = NULL){
 #' @import data.table
 #' @importFrom grDevices pdf dev.off
 #' @importFrom graphics plot.new text
+#' @importFrom ggplot2 ggplot geom_line aes facet_wrap labs
 #' @export
 
 
 compareOutputs <- function(runs, pdf_path){
- scen <- all_regi <- tall <- value <- i.value <- V1 <- NULL
+ scen <- all_regi <- tall <- value <- i.value <- V1 <- all_teEs <- NULL
  fe2es <- rbindlist(lapply(names(runs), function(scen){
  fread(file.path(runs[[scen]], "level_2/fe2es.cs4r"))[, scen := scen]
  }))

R/lvl0_loadSources.R

@@ -14,8 +14,12 @@
 
 
 lvl0_loadEU <- function(input_folder, EU_dir = "EU_data") {
- countries <- tech_output <- technologies <- `.` <- region <- EDGE_vehicle_type <- MJ <- mtoe <- km_million <- country_name <- technology <- tkm_million <- MJ_km <- load_factor <- million_tkm <- Liquids <- Electric <- pkm_million <- ktkm <- pkm <- name <- code_airplane_characteristics <- sector_fuel <- vehicle_type <- NULL
- EJ <- RailTraction <- RailTrafficType <- Unit_short <- convert <- value <- annual_mileage <- NULL
+ countries <- tech_output <- technologies <- `.` <- region <- EDGE_vehicle_type <- MJ <-
+ mtoe <- km_million <- country_name <- technology <- tkm_million <- MJ_km <- load_factor <-
+ million_tkm <- Liquids <- Electric <- pkm_million <- ktkm <- pkm <- name <-
+ code_airplane_characteristics <- sector_fuel <- vehicle_type <- TRACCS_category <-
+ EJ <- RailTraction <- RailTrafficType <- Unit_short <- convert <- value <- annual_mileage <-
+ NULL
  TRACCS_technology <- vkm <- tkm <- NULL
  EU_folder <- file.path(input_folder, EU_dir)
 

R/lvl0_mergeDat.R

@@ -26,10 +26,12 @@
 lvl0_mergeDat = function(UCD_output, EU_data, PSI_costs, GDP_MER, altCosts, CHN_trucks, GCAM_data,
  PSI_int, trsp_incent, fcr_veh, nper_amort_veh, smartlifestyle,
  SSP_scen, years, REMIND2ISO_MAPPING, ariadne_adjustments = TRUE) {
- vkm.veh <- value <- variable <- conv_pkm_MJ <- conv_vkm_MJ <- ratio <- MJ_km <- sector_fuel <- subsector_L3 <- `.` <- NULL
- k <- subsector_L2 <- tech_output <- MJ <- region <- loadFactor <- vehicle_type <- iso <- univocal_name <- technology <- weight <- NULL
- pkm_MJ_missing <- val <- markup <- UCD_technology <- valUCD <- gdpcap <- NULL
- subsector_L1 <- vkm.veh <- tot_purchasecost <- aveval <- incentive_val <- unit <- demldv <- NULL
+
+ vkm.veh <- value <- variable <- conv_pkm_MJ <- conv_vkm_MJ <- ratio <- MJ_km <- sector_fuel <-
+ subsector_L3 <- `.` <- k <- subsector_L2 <- tech_output <- MJ <- region <- loadFactor <-
+ vehicle_type <- iso <- univocal_name <- technology <- weight <- pkm <- sector <-
+ pkm_MJ_missing <- val <- markup <- UCD_technology <- valUCD <- gdpcap <- subsector_L1 <-
+ vkm.veh <- tot_purchasecost <- aveval <- incentive_val <- unit <- demldv <- NULL
  logit_cat = copy(GCAM_data[["logit_category"]])
  logit_cat = rbind(logit_cat,
  logit_cat[subsector_L1 == "trn_pass_road_LDV_4W" & technology == "BEV"][, technology := "Hybrid Electric"])
@@ -471,8 +473,12 @@ lvl0_mergeDat = function(UCD_output, EU_data, PSI_costs, GDP_MER, altCosts, CHN_
 
  LF = merge(LF, unique(dem[!vehicle_type %in% c("Cycle_tmp_vehicletype", "Walk_tmp_vehicletype"),c("iso", "vehicle_type", "technology", "subsector_L1", "subsector_L2", "subsector_L3", "sector", "year")]), all.y = TRUE, by = c("iso", "vehicle_type", "technology", "subsector_L1", "subsector_L2", "subsector_L3", "sector", "year"))
  LF[, loadFactor := ifelse(is.na(loadFactor), mean(loadFactor, na.rm = TRUE), loadFactor), by = c("year", "vehicle_type")]
- LF[year > 2100, loadFactor := rep(LF[year == 2100]$loadFactor, 3)]
- if(nrow(LF[is.na(loadFactor) | loadFactor == 0]) > 0){
+ LF <- LF[year <= 2100]
+ LF <- rbind(LF,
+ LF[year==2100][, year := 2110],
+ LF[year==2100][, year := 2130],
+ LF[year==2100][, year := 2150])
+ if(nrow(LF[is.na(loadFactor) | loadFactor == 0]) > 0) {
  stop("Zero load factor provided.")
  }
 

R/merge_prices.R

@@ -18,10 +18,10 @@ merge_prices <- function(gdx, REMINDmapping, REMINDyears,
  intensity_data,
  nonfuel_costs,
  module="edge_esm", FE_Pricetab = NULL) {
-  sector_fuel <- ttot <- value <- fuel_price <- fuel_price_pkm <- EJ_Mpkm_final <- NULL
- non_fuel_price <- technology <- GDP_cap <- region <- `.` <- weight <- POP_val <- NULL
- GDP <- `elect_td_trn` <- time <- `Liquids-Electricity` <- `refined liquids enduse` <- NULL
- vehicle_type <- subsector_L3 <- subsector_L2 <- subsector_L1 <- sector <- tot_price <- NULL
+ sector_fuel <- ttot <- value <- fuel_price <- fuel_price_pkm <- EJ_Mpkm_final <- non_fuel_price <-
+ technology <- GDP_cap <- region <- `.` <- weight <- POP_val <- GDP <- `elect_td_trn` <- time <-
+  `Liquids-Electricity` <- `refined liquids enduse` <- vehicle_type <- subsector_L3 <-
+   subsector_L2 <- subsector_L1 <- sector <- tot_price <- value.x <- value.y <- NULL
  ## report prices from REMIND gdx in 2005$/GJ
 
  tdptwyr2dpgj <- 31.71 #TerraDollar per TWyear to Dollar per GJ

R/reportEDGETransport2.R

@@ -21,23 +21,22 @@
 #' @importFrom quitte as.quitte aggregate_map
 #' @importFrom magclass as.magpie getItems getNames mselect dimSums
 #' @importFrom rmndt approx_dt readMIF writeMIF
-#' @importFrom dplyr %>%
+#' @importFrom magrittr %>%
 #' @export
 
 reportEDGETransport2 <- function(output_folder = ".",
  extendedReporting = FALSE,
  scenario_title = NULL, model_name = "EDGE-Transport",
  gdx = NULL) {
 
-
- ## NULL Definitons for codeCheck compliance
- RegionCode <- `.` <- sector <- subsector_L3 <- region <- year <- NULL
- subsector_L2 <- subsector_L1 <- NULL
- demand_F <- remind_rep <- aggr_veh <- technology <- NULL
- ttot <- se_share <- fe_demand <- variable <- value <- loadFactor <- NULL
- all_enty <- ef <- variable_agg <- aggr_mode <- det_veh <- model <- scenario <- period <- NULL
- se <- type <- ven <- vehicle_type <- vehicle_type <- capture.output <- NULL
- unit <- tot_VOT_price <- tot_price <- logit_type <- weight <- liqsplit <- setNames <- NULL
+ RegionCode <- `.` <- sector <- subsector_L3 <- region <- year <- fuel <- demNew <- totdem <-
+ subsector_L2 <- subsector_L1 <- demand_F <- remind_rep <- aggr_veh <- technology <- ttot <-
+ se_share <- fe_demand <- variable <- value <- loadFactor <- sharetech_new <- shareVS1 <-
+ all_enty <- ef <- variable_agg <- aggr_mode <- det_veh <- model <- scenario <- period <-
+ se <- type <- ven <- vehicle_type <- vehicle_type <- capture.output <- demVintEachYear <-
+ unit <- tot_VOT_price <- tot_price <- logit_type <- weight <- liqsplit <- setNames <-
+ full_demand_vkm <- vintage_demand_vkm <- stock_demand <- sales_demand <- full_demand_vkm <-
+ typ <- FE <- NULL
 
  #pkm or tkm is called km in the reporting. Vehicle km are called vkm
  yrs <- c(seq(2005, 2060, 5), seq(2070, 2100, 10))

README.md

@@ -1,8 +1,8 @@
 # Prepare EDGE Transport Data for the REMIND model
 
-R package **edgeTransport**, version **0.16.0**
+R package **edgeTransport**, version **0.17.0**
 
-[![CRAN status](https://www.r-pkg.org/badges/version/edgeTransport)](https://cran.r-project.org/package=edgeTransport)   [![r-universe](https://pik-piam.r-universe.dev/badges/edgeTransport)](https://pik-piam.r-universe.dev/ui#builds)
+[![CRAN status](https://www.r-pkg.org/badges/version/edgeTransport)](https://cran.r-project.org/package=edgeTransport) [![R build status](https://github.com/pik-piam/edgeTransport/workflows/check/badge.svg)](https://github.com/pik-piam/edgeTransport/actions) [![codecov](https://codecov.io/gh/pik-piam/edgeTransport/branch/master/graph/badge.svg)](https://app.codecov.io/gh/pik-piam/edgeTransport) [![r-universe](https://pik-piam.r-universe.dev/badges/edgeTransport)](https://pik-piam.r-universe.dev/ui#builds)
 
 ## Purpose and Functionality
 
@@ -46,7 +46,7 @@ In case of questions / problems please contact Alois Dirnaichner <dirnaichner@pi
 
 To cite package **edgeTransport** in publications use:
 
-Dirnaichner A, Rottoli M (2022). _edgeTransport: Prepare EDGE Transport Data for the REMIND model_. R package version 0.16.0.
+Dirnaichner A, Rottoli M (2022). _edgeTransport: Prepare EDGE Transport Data for the REMIND model_. R package version 0.17.0.
 
 A BibTeX entry for LaTeX users is
 
@@ -55,6 +55,6 @@ A BibTeX entry for LaTeX users is
  title = {edgeTransport: Prepare EDGE Transport Data for the REMIND model},
  author = {Alois Dirnaichner and Marianna Rottoli},
  year = {2022},
- note = {R package version 0.16.0},
+ note = {R package version 0.17.0},
 }
 ```