required_parameters: Lookup the Details of Parameters Required by a Model

In seabbs/idmodelr: Infectious Disease Model Library and Utilities

Lookup the Details of Parameters Required by a Model

Description

This function simplifies the process of checking which parameters a given idmodelr model depends on. It is effectively an interface to parameter_details via model_details. As fuzzy matching has been used it can also given information of the parameter requirements of a subset of the available models.

Usage

required_parameters(model = NULL)

Arguments

model

A character string containing the name of the model of interest. Defaults to NULL.

Value

A dataframe extracted from parameter_details containing the details of the parameters required by the model of interest.

Examples

## Check the parameters required by the "SIR_ode" model
required_parameters("SIR_ode")


## Use fizzy matching to look at parameters for all SIR models
required_parameters("SIR")

seabbs/idmodelr documentation built on Sept. 5, 2022, 11:32 a.m.