Add extra information to a scenario

Usage

sce_add_info(x, info)

Arguments

x: A scenario object.
info: A named list of information to be added to the extra_info list of the scenario object x.

Value

The scenario x with the extra information added.

Examples

# get some parameters for a `finalsize` run
parameters <- make_parameters_finalsize_UK(r0 = 1.5)
extra_info <- list(
  age_groups = rownames(parameters$contact_matrix)
)
x <- scenario(
  model_function = "finalsize::final_size",
  parameters = parameters
)

sce_add_info(x, extra_info)
#> Epidemic scenario object
#>  Scenario name: No name specified (NA)
#>  Model function: finalsize::final_size
#>  Extra information on: "age_groups"
#>  Scenario replicates: 1
#>  Scenario outcomes are not prepared