Merge pull request #266 from johannah-pik/Refactoring

edgeTransport 2.0 release

.buildlibrary

@@ -1,9 +1,9 @@
-ValidationKey: '3069465'
+ValidationKey: '3984200'
 AutocreateReadme: yes
 AcceptedWarnings:
 - 'Warning: package ''.*'' was built under R version'
 - 'Warning: namespace ''.*'' is not available and has been replaced'
 - '''.*'' is needed for checks on size reduction of PDFs'
-AcceptedNotes: checking installed package size
+AcceptedNotes: 'Undefined global functions or variables:'
 allowLinterWarnings: yes
 enforceVersionUpdate: no

.github/workflows/check.yaml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - uses: r-lib/actions/setup-pandoc@v2
 
@@ -23,7 +23,6 @@ jobs:
       - uses: r-lib/actions/setup-r-dependencies@v2
         with:
           extra-packages: |
-            gamstransfer=?ignore
             any::lucode2
             any::covr
             any::madrat
@@ -36,7 +35,7 @@ jobs:
           # gms, goxygen, GDPuc) will usually have an outdated binary version
           # available; by using extra-packages we get the newest version
 
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: 3.9
 

.pre-commit-config.yaml

@@ -3,7 +3,7 @@
 exclude: '^tests/testthat/_snaps/.*$'
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: 2c9f875913ee60ca25ce70243dc24d5b6415598c  # frozen: v4.6.0
     hooks:
     -   id: check-case-conflict
     -   id: check-json
@@ -15,7 +15,7 @@ repos:
     -   id: mixed-line-ending
 
 -   repo: https://github.com/lorenzwalthert/precommit
-    rev: v0.4.0
+    rev: 7910e0323d7213f34275a7a562b9ef0fde8ce1b9  # frozen: v0.4.2
     hooks:
     -   id: parsable-R
     -   id: deps-in-desc

CITATION.cff

@@ -2,23 +2,28 @@ 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: 1.5.5
-date-released: '2024-03-21'
+version: 2.0.0
+date-released: '2024-07-17'
 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
   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`.
 authors:
+- family-names: Hoppe
+  given-names: Johanna
+  email: [email protected]
+  orcid: https://orcid.org/0009-0004-6753-5090
 - family-names: Dirnaichner
   given-names: Alois
   email: [email protected]
 - family-names: Rottoli
   given-names: Marianna
   email: [email protected]
-- family-names: Hoppe
-  given-names: Johanna
+- family-names: Muessel
+  given-names: Jarusch
+  email: [email protected]
 license: GPL-3.0
 repository-code: https://github.com/pik-piam/edgeTransport
 

DESCRIPTION

@@ -1,42 +1,37 @@
 Package: edgeTransport
 Title: Prepare EDGE Transport Data for the REMIND model
-Version: 1.5.5
+Version: 2.0.0
 Authors@R: c(
-    person("Alois", "Dirnaichner", email = "[email protected]", role = c("aut", "cre")),
+    person("Johanna", "Hoppe", , "[email protected]", role = c("aut", "cre"),
+           comment = c(ORCID = "0009-0004-6753-5090")),
+    person("Alois", "Dirnaichner", email = "[email protected]", role = "aut"),
     person("Marianna", "Rottoli", email = "[email protected]", role = "aut"),
-    person("Johanna", "Hoppe", role = "aut"))
+    person("Jarusch", "Muessel", , "[email protected]", role = "aut"))
 Description: 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`.
 Depends:
-    R (>= 3.1),
+    R (>= 3.5.0),
     data.table (>= 1.11.0)
 License: GPL-3
 URL: https://github.com/pik-piam/edgeTransport
 Encoding: UTF-8
 LazyData: true
 RoxygenNote: 7.3.1
 VignetteBuilder: knitr
-Date: 2024-03-21
+Date: 2024-07-17
 Config/testthat/edition: 3
 Imports:
     rmndt,
     magclass,
-    readxl,
-    rmarkdown,
     rootSolve,
     madrat,
-    ggplot2,
-    quitte,
-    zoo,
     magrittr,
     gdx,
     gdxrrw,
+    zoo,
     gdxdt,
-    remind2,
-    rlang,
-    yaml,
-    ymlthis
+    reporttransport (>= 0.0.10)
 Suggests:
-    testthat,
+    testthat (>= 3.0.0),
     knitr,
     markdown,
     covr

NAMESPACE

@@ -1,83 +1,43 @@
 # Generated by roxygen2: do not edit by hand
 
-export(calcgenerateEDGEdata)
-export(collectScens)
-export(compareOutputs)
-export(compareScenarios_EDGET)
-export(toolCalcVint)
-export(toolCalculateLogitIncost)
-export(toolCalculateLogitSW)
-export(toolCapCosts)
-export(toolCreateRDS)
-export(toolDemandReg)
-export(toolGenerateEDGEdata)
-export(toolIterativeEDGETransport)
-export(toolLearning)
-export(toolLoadInputData)
-export(toolMergePrices)
-export(toolPrepare4REMIND)
-export(toolReadREMINDdemand)
-export(toolReportEDGET)
-export(toolSharesIntensityDemand)
-export(toolVehicleStations)
+export(calcEdgeTransportSA)
+export(calculateShares)
+export(checkForNAsDups)
+export(csv2RDS)
+export(getFilterEntriesUnivocalName)
+export(iterativeEdgeTransport)
+export(toolApplyMixedTimeRes)
+export(toolCalculateFS3share)
+export(toolCalculateFleetComposition)
+export(toolCheckAllLevelsComplete)
+export(toolDemandRegression)
+export(toolDiscreteChoice)
+export(toolEdgeTransportSA)
+export(toolLoadDecisionTree)
+export(toolLoadInputs)
+export(toolLoadIterativeInputs)
+export(toolLoadREMINDesDemand)
+export(toolOrderandCheck)
+export(toolPrepareScenInputData)
+export(toolTraverseDecisionTree)
+export(toolUpdateEndogenousCosts)
 import(data.table)
-import(rmndt)
-importFrom(data.table,CJ)
-importFrom(data.table,copy)
-importFrom(data.table,frank)
 importFrom(data.table,fread)
-importFrom(data.table,fwrite)
-importFrom(data.table,rbindlist)
-importFrom(data.table,shift)
 importFrom(gdx,readGDX)
-importFrom(gdxdt,readgdx)
+importFrom(gdxdt,writegdx)
 importFrom(gdxdt,writegdx.parameter)
 importFrom(gdxrrw,rgdx)
-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(madrat,calcOutput)
-importFrom(madrat,readSource)
-importFrom(magclass,"getSets<-")
-importFrom(magclass,as.magpie)
-importFrom(magclass,dimSums)
-importFrom(magclass,getItems)
-importFrom(magclass,getNames)
-importFrom(magclass,getSets)
-importFrom(magclass,getYears)
 importFrom(magclass,lowpass)
-importFrom(magclass,mbind)
-importFrom(magclass,mselect)
-importFrom(magclass,setNames)
-importFrom(magclass,time_interpolate)
-importFrom(magrittr,"%>%")
-importFrom(quitte,aggregate_map)
-importFrom(quitte,as.quitte)
-importFrom(quitte,write.mif)
-importFrom(readxl,read_excel)
-importFrom(remind2,toolRegionSubsets)
-importFrom(rlang,parse_expr)
-importFrom(rmarkdown,render)
-importFrom(rmndt,aggregate_dt)
+importFrom(magrittr,`%>%`)
+importFrom(reporttransport,reportEdgeTransport)
+importFrom(reporttransport,reportToREMINDcapitalCosts)
+importFrom(reporttransport,reportToREMINDenergyEfficiency)
+importFrom(reporttransport,reportToREMINDfinalEnergyShares)
+importFrom(reporttransport,storeData)
 importFrom(rmndt,approx_dt)
-importFrom(rmndt,disaggregate_dt)
 importFrom(rmndt,magpie2dt)
-importFrom(rmndt,readMIF)
-importFrom(rmndt,writeMIF)
 importFrom(rootSolve,multiroot)
-importFrom(stats,complete.cases)
-importFrom(stats,na.omit)
-importFrom(utils,read.csv)
-importFrom(yaml,yaml.load)
-importFrom(ymlthis,as_yml)
-importFrom(ymlthis,use_rmarkdown)
-importFrom(ymlthis,yml_params_code)
-importFrom(ymlthis,yml_replace)
+importFrom(stats,approxfun)
+importFrom(utils,capture.output)
 importFrom(zoo,na.approx)
-importFrom(zoo,na.spline)