get_scenario_description: Get scenario description

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

get_scenario_descriptionR Documentation

Get scenario description

Description

Get scenario description

Usage

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

Arguments

scenario

a 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

a string describing the optimisation ran


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