calmr (version 0.7.0)

model_information: Model information functions

Description

An assortment of functions to return model information.

Usage

supported_models()
supported_timed_models()
supported_optimizers()
supported_families()
supported_plots(model = NULL)
get_model(model)
model_parameters(model = NULL)
model_outputs(model = NULL)

Value

supported_models() returns a character vector.

supported_timed_models() returns a character vector.

supported_optimizers() returns a character vector.

supported_families() returns a character vector.

supported_plots() returns a character vector or list (if model is NULL).

get_model() returns a model function.

model_parameters() returns a list or a list of lists (if model is NULL).

model_outputs() returns a character vector or list (if model is NULL).

Arguments

model

A string specifying a model. One from supported_models().

Examples

# Outputs and plots supported by the RW1972 model
model_outputs("RW1972")

# Getting the model function implementing the PKH1982 model
pkh_func <- get_model("PKH1982")
head(pkh_func, 10)

# Getting the parameters required by SM2007
model_parameters("SM2007")