LoadBlockbusterOutput: Load data from the blockbuster output files.

Description Usage Arguments Details Value Examples

Description

This function loads the blockbuster outputs into memory from the saved files produced during a call to Blockbuster.

Usage

1
2
LoadBlockbusterOutput(forecast.horizon, filelabel = "blockbuster_output",
  path = "./output/")

Arguments

forecast.horizon

The number of timesteps to collate.

filelabel

Character. The file label on the output files. This corresponds to the filelabel argument passed to Blockbuster. Default is "blockbuster_output".

path

Character. The path to the folder containing the saved files. This corresponds to the path argument passed to Blockbuster. Default is "./output/".

Details

The files are expected to end in "_element_i" and "block_i", with i being the timestep plus one. If the data input to Blockbuster is large then R may run out of memory when creating the final output. For this reason the state of the estate can be saved to disc and the final output reconstructed at the end of the process, or outside of the Blockbuster call.

Value

A list of lists. There is one list entry for each timestep, so the output will be of length forecast.horizon + 1 as the first will contain the initial state. Each list entry contains a block-level and element-level data frame named block and element respectively.

Examples

1
2
3
4
5
## Not run: 
# Load the first ten years of output from the default folder
LoadBlockbusterOutput(10)

## End(Not run)

DFE-Capital/blockbuster2 documentation built on May 4, 2019, 1:08 p.m.