---
title: "EnergyDemandGenerator-Transport Model (EDGE-T)"
author: "Johanna Hoppe"
date: "`r Sys.Date()`"
output: rmarkdown::html_vignette
vignette: >
  %\VignetteIndexEntry{EnergyDemandGenerator-Transport Model (EDGE-T)}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---

## Description

lore ipsum

## Usage

The package can be installed from github...

Data can be generated as follows:

`
toolEdgeTransportSA <- function(SSPscen,
                                transportPolScen,
                                isICEban = FALSE,
                                demScen = "default",
                                gdxPath = NULL,
                                outputFolder = ".",
                                isStored = TRUE,
                                isTransportReported = TRUE,
                                isTransportExtendedReported = FALSE,
                                isREMINDinputReported = FALSE,
                                isAnalyticsReported = FALSE)
`

Where:

`SSPscen` character string containing the selected SSP scenario. Options are: `SSP1`, `SSP2`

`transportPolScen` character string containing the transport policy scenario. Options are: 

`demScen` character string containing the demand scenario, used to apply reduction factors on total demands from the regression. Options are:

`gdxPath` character string containing a path to a REMIND fulldata.gdx to load the fuel price trajectories from. 

`outputFolder` character string containing a path to a folder for storing output data

`isStored` boolean for optional saving of intermediate RDS files

`isTransportReported` boolean for optional transport reporting in model intercomparison formate (MIF)

`isTransportExtendedReported` boolean for optional extension of transport reporting providing more detailed variables

`isREMINDinputReported` boolean for optional reporting of REMIND input data

`isAnalyticsReported` boolean for optional reporting of analytics data (e.g. variables over iterations)

## Data generation structure

lore ipsum

## Scenarios description

lore ipsum
## References

lore ipsum - credits mariannas paper