rw_scen_gen_names: Create a vector of scenarios from different dimensions

In BoulderCodeHub/RWDataPlyr: Read and Manipulate Data from 'RiverWare'

Create a vector of scenarios from different dimensions

Description

rw_scen_gen_names() creates a vector of full scenario names by combining multiple dimensions together.

Usage

rw_scen_gen_names(dim1, dim2, ..., sep = ",")

makeAllScenNames(dim1, dim2, ..., sep = ",")

Arguments

dim1	A character vector with all of the first dimension's names.
dim2	A character vector with all of the second dimension's names.
...	As many individual character vectors as necessary for the remaining dimension's names.
sep	The character used to separate the different dimension names. Defaults to",".

Details

Many RiverWare runs are specified by multiple dimensions (or assumptions), and RiverSMART creates folder names by combining the dimension names together for a full scenario name. rw_scen_gen_names() makes it quick to create all of the full scenario names by passing in the names of the individual dimensions and creating all possible combinations of all dimensions.

For example, the RiverWare run might consist of a supply dimension and a demand dimension, each consisting of two scenarios. This would result in four total scenarios.

The function will work with two or more dimensions, as there is no need for this function if there is only one dimension.

Value

A character vector of all possible combinations of the dimensions.

Functions

• makeAllScenNames: Deprecated version of rw_scen_gen_names()

Examples

rw_scen_gen_names("DNF", "CT", c("IG", "NA"), c("MTOM", "24-MS"))
rw_scen_gen_names("DNF", "CT", c("IG", "NA"), sep = "_")

BoulderCodeHub/RWDataPlyr documentation built on May 8, 2023, 3:55 a.m.