run_twsa_det {dampack}R Documentation

Run deterministic two-way sensitivity analysis (TWSA)

Description

This function runs a deterministic two-way sensitivity analysis (TWSA) on a given function that produces outcomes.

Usage

run_twsa_det(
  params_range,
  params_basecase,
  nsamp = 40,
  FUN,
  outcomes = NULL,
  strategies = NULL,
  progress = TRUE,
  ...
)

Arguments

params_range

data.frame with 2 rows and 3 columns in the following order: "pars", "min", and "max". The number of samples from this range is determined by nsamp. "pars" are the 2 parameters of interest, which must be a subset of the parameters from params_basecase.

params_basecase

a named list of basecase values for input parameters needed by FUN, the user-defined function.

nsamp

number of parameter values. If NULL, 40 parameter values are used

FUN

Function that takes the basecase in params_all and ... to produce the outcome of interest. The FUN must return a dataframe where the first column are the strategy names and the rest of the columns must be outcomes.

outcomes

String vector with the outcomes of interest from FUN produced by nsamp

strategies

vector of strategy names. The default (NULL) will use strategy names in FUN

progress

TRUE or FALSE for whether or not function progress should be displayed in console.

...

Additional arguments to user-defined FUN

Value

A list containing dataframes with the results of the sensitivity analyses. The list will contain a dataframe for each outcome specified.

Details


[Package dampack version 1.0.1 Index]