How e3modelling/postprom works
Project type and purpose
• This is an R package (“postprom”) whose primary purpose is to convert OPEN-PROM model outputs (GDX files) into a Model Inter-comparison Format (MIF), link them to the magpie data structure, run a suite of comparative analyses (activity, GDP, emissions, etc.), and generate PDF reports.
• It is a command-line/library tool rather than a web app. It exposes R functions (in R/*.R) and ships with helper scripts (Python and RMarkdown/LaTeX templates) under inst/.
File structure
• Top level:
• DESCRIPTION, NAMESPACE: standard R package metadata
• R/: core R functions for data conversion (convertGDXtoMIF, readData, getMetadata), data linking (linkPromToMagpie), report modules (reportACTV, reportEmissions, …), plotting & orchestration (plotReport.R, batchPlotReport.R)
• inst/extdata/: static CSVs for plot‐mapping and styling
• inst/templates/: PDF report templates in RMarkdown (.Rmd) and Sweave (.Rnw)
• inst/scripts/reporting.py: Python wrapper for batch runs or cross-platform orchestration
• man/: auto‐generated Rd documentation for each R function
• There are no “frontend/backend” directories; instead the “backend” is the R code and the “presentation layer” is the PDF templates.
README
• It confirms the tool is for comparative analysis of OPEN-PROM data.
Final advice
• Be exhaustive: represent every stage and resource folder (extdata, templates).
• Dependencies (e.g., R → knitr → LaTeX).
• Don’t clutter with every man/ folder file—focus on functional components.