set_scenario_settings: Set key scenario information: budget or target

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

set_scenario_settingsR Documentation

Set key scenario information: budget or target

Description

This function takes a scenario object, and updates the scenario to optimise to the desired budget or target. If a base case scenario is required - budget and target should be NA

Usage

set_scenario_settings(scenario, user_budget = NA, user_target = NA)

Arguments

scenario

scenario list-object.

user_budget

the specified budget as a numeric (no units) or NA if best case

user_target

the specified target as a numeric (no units) or NA if no target required

Value

updated scenario list-object not exported as it is called by the set_scenario function


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