Scenario: Construct a scenario structure
In rplzzz/CovMitigation: COVID-19 infection model for Virginia

Description Usage Arguments Details Value Notes

A scenario structure is a list of data frames. Each list element pertains to one model variable. The data frame for the variable gives the change in the parameter by time and locality.

1	Scenario(scen)

scen

Input data frame describing the scenario. See details.

The input data frame should include the following columns:

locality: The locality the change applies to. A NA value here means the change is a default that will apply to any locality without a specified change.
time: The time at which a change in a parameter occurs. The parameter will remain at its changed value until another change is imposed.
parm: Parameter affected by the change
isrelative: Flag indicating whether the change is a multiplier (TRUE) or an adder (FALSE) to the base value.
value: The change factor. This will be treated as an adjustment to the parameter's value at the end of the historical period.

A scenario structure.

Although the relative flag is given at each time step (due to the limitations of the data frame structure), having an adjustment that is relative at some times and absolute at others is not supported. A mixed vector for the isrelative flag will result in the adjustment being treated as absolute (i.e., additive).

Changes for times in the past (prior to the start of the projection) are ignored; however, the most recent such change will take effect in the first future time step. Thus, one can keep using the same scenario structure week after week as the model gets updated.

rplzzz/CovMitigation documentation built on June 7, 2021, 8:48 a.m.