Merge pull request #296 from johannah-pik/master

Fix function calls iterative script

.buildlibrary

@@ -1,4 +1,4 @@
-ValidationKey: '5607280'
+ValidationKey: '5628711'
 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: 'edgeTransport: Prepare EDGE Transport Data for the REMIND model'
-version: 2.8.0
-date-released: '2024-10-30'
+version: 2.8.1
+date-released: '2024-11-04'
 abstract: 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

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: edgeTransport
 Title: Prepare EDGE Transport Data for the REMIND model
-Version: 2.8.0
+Version: 2.8.1
 Authors@R: c(
     person("Johanna", "Hoppe", , "[email protected]", role = c("aut", "cre"),
            comment = c(ORCID = "0009-0004-6753-5090")),
@@ -19,7 +19,7 @@ Encoding: UTF-8
 LazyData: true
 RoxygenNote: 7.3.2
 VignetteBuilder: knitr
-Date: 2024-10-30
+Date: 2024-11-04
 Config/testthat/edition: 3
 Imports:
     rmndt,

NAMESPACE

@@ -9,7 +9,9 @@ export(iterativeEdgeTransport)
 export(toolApplyICEbanOnPreferences)
 export(toolApplyMixedTimeRes)
 export(toolCalculateFS3share)
+export(toolCalculateFVdemand)
 export(toolCalculateFleetComposition)
+export(toolCalculateVehicleDepreciationFactors)
 export(toolCheckAllLevelsComplete)
 export(toolDemandRegression)
 export(toolDiscreteChoice)
@@ -18,8 +20,10 @@ export(toolLoadDecisionTree)
 export(toolLoadInputs)
 export(toolLoadIterativeInputs)
 export(toolLoadREMINDesDemand)
+export(toolLoadREMINDfuelCosts)
 export(toolNormalizePreferences)
 export(toolOrderandCheck)
+export(toolPrepareDataEndogenousCosts)
 export(toolPrepareScenInputData)
 export(toolTraverseDecisionTree)
 export(toolUpdateEndogenousCosts)

R/iterativeEDGETransport.R

@@ -175,7 +175,7 @@ iterativeEdgeTransport <- function() {
                                                 helpers)
 
     ESdemandFVsalesLevel <- toolCalculateFVdemand(inputData$REMINDsectorESdemand,
-                                                  vehSalesAndModeShares,
+                                                  vehSalesAndModeShares$shares,
                                                   helpers,
                                                   inputData$histESdemand,
                                                   baseYear)
@@ -186,7 +186,7 @@ iterativeEdgeTransport <- function() {
     # Calculate vehicle stock for cars, trucks and busses -------
     fleetSizeAndComposition <- toolCalculateFleetComposition(ESdemandFVsalesLevel,
                                                              vehicleDepreciationFactors,
-                                                             vehSalesAndModeShares,
+                                                             vehSalesAndModeShares$shares,
                                                              inputData$annualMileage,
                                                              inputData$scenSpecLoadFactor,
                                                              helpers)

R/toolCalculateFVdemand.R

@@ -1,3 +1,15 @@
+#' Calculate eneryg service demand on fuel vehicle level
+#'
+#' @author Johanna Hoppe
+#' @param sectorESdemand energy service demand on CES node level
+#' @param salesAndModeShares vehicle sales and mode shares
+#' @param helpers List with helpers
+#' @param histESdemand historcial energy service demand for iterative EDGE-T
+#' @param baseYear ned year of historical energy service demand
+#' @returns data.table 
+#' @import data.table
+#' @export
+
 toolCalculateFVdemand <- function(sectorESdemand, salesAndModeShares, helpers, histESdemand = NULL,  baseYear = NULL){
 
 # Calculate FV to sector shares --------------------------------------------

R/toolCalculateVehicleDepreciationFactors.R

@@ -5,6 +5,7 @@
 #' @param helpers list with helpers
 #' @returns data.table including vehicle depreciation factors over service life#'
 #' @import data.table
+#' @export
 
 toolCalculateVehicleDepreciationFactors <- function(annuityCalc, helpers) {
 

R/toolLoadREMINDfuelCosts.R

@@ -11,6 +11,7 @@
 #' @importFrom gdx readGDX
 #' @importFrom magclass lowpass
 #' @importFrom magrittr `%>%`
+#' @export 
 
 toolLoadREMINDfuelCosts <- function(gdxPath, hybridElecShare, helpers){
  value <- unit <- variable <- `Hybrid electric` <- fuel <- NULL

R/toolPrepareDataEndogenousCosts.R

@@ -6,6 +6,7 @@
 #' @param helpers List with helpers
 #' @returns data.table including all cost components
 #' @import data.table
+#' @export
 
 toolPrepareDataEndogenousCosts <- function(inputData, lambdas, helpers) {
 

README.md

@@ -1,6 +1,6 @@
 # Prepare EDGE Transport Data for the REMIND model
 
-R package **edgeTransport**, version **2.8.0**
+R package **edgeTransport**, version **2.8.1**
 
 [![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/builds)
 
@@ -46,7 +46,7 @@ In case of questions / problems please contact Johanna Hoppe <johanna.hoppe@pik-
 
 To cite package **edgeTransport** in publications use:
 
-Hoppe J, Dirnaichner A, Rottoli M, Muessel J (2024). _edgeTransport: Prepare EDGE Transport Data for the REMIND model_. R package version 2.8.0, <https://github.com/pik-piam/edgeTransport>.
+Hoppe J, Dirnaichner A, Rottoli M, Muessel J (2024). _edgeTransport: Prepare EDGE Transport Data for the REMIND model_. R package version 2.8.1, <https://github.com/pik-piam/edgeTransport>.
 
 A BibTeX entry for LaTeX users is
 
@@ -55,7 +55,7 @@ A BibTeX entry for LaTeX users is
   title = {edgeTransport: Prepare EDGE Transport Data for the REMIND model},
   author = {Johanna Hoppe and Alois Dirnaichner and Marianna Rottoli and Jarusch Muessel},
   year = {2024},
-  note = {R package version 2.8.0},
+  note = {R package version 2.8.1},
   url = {https://github.com/pik-piam/edgeTransport},
 }
 ```