set_scenario: Set all scenario information

View source: R/funcs_set-get-scenario.R

set_scenarioR Documentation

Set all scenario information

Description

This function takes a scenario object, plus the desired optimisation specification parameters, and updates the scenario object by updating or populating curves_filtered

Usage

set_scenario(
  scenario,
  period,
  budget,
  kpi1,
  kpi2 = NULL,
  kpi3 = NULL,
  constraints_list = NULL
)

Arguments

scenario

scenario list-object.

period

the specified period as a string

budget

the specifed budget as a numeric

kpi1

the specified kpilevel1 as a string

kpi2

the specified kpilevel2 as a string

kpi3

the specified kpilevel3 as a string

constraints_list

list where each element is a tibble with required constraints

Value

updated scenario list-object, with curves_filtered ready to pass to optimisation


cath-parkinson/mm.reoptimise documentation built on May 12, 2022, 3:34 p.m.