genOutputList: Generate list of outputs

Description Usage Arguments Value

View source: R/generateOutputList.R

Description

This function pulls data generated by recoverySim from a given directory and binds it into a list. Each first order list element consists of a single scenario (i.e. one OM and one MP). The second order list elements depend on whether CU-specific, aggregate, or aggregate time series data are extracted.

Usage

1
2
3
4
5
6
7
genOutputList(
  dirName,
  subDirName = NULL,
  selectedCUs = NULL,
  agg = TRUE,
  aggTS = FALSE
)

Arguments

dirName

A character vector representing the directory to pull data from.

subDirName

An optional character vector used to specify a single subdirectory within dirName to pull data from.

selectedCUs

An optional character vector of CU names used to subset output data if CU-specific data are being pulled (i.e. agg = FALSE).

agg

A logical stating whether aggregate (TRUE; default) or CU-specific (FALSE) data should be pulled.

aggTS

A logical stating whether aggregate summary performance metric data (FALSE; default) or aggregate time series data (TRUE) should be pulled.

Value

Returns a list of output data of length equal to the number of unique scenarios within a directory.


TESA-workshops/TESAsamSim documentation built on Feb. 6, 2021, 12:25 a.m.