model_setup: Load models and set up lists and classes for the base model,...

In pbs-assess/gfiscamutils: Provide functions for iSCAM models

Load models and set up lists and classes for the base model, bridge model groups, and sensitivity model groups

Description

Load models and set up lists and classes for the base model, bridge model groups, and sensitivity model groups

Usage

model_setup(
  drs = NA,
  base_models_desc = NA,
  bridge_models_desc = NA,
  sens_models_desc = NA,
  retro_models_desc = NA,
  ...
)

Arguments

drs	Output list from set_dirs()
base_models_desc	A list of descriptions for the base models
bridge_models_desc	A list of vectors of text strings to show in the legends for bridge model plots, one name for each model, where the list elements represent a group of models
sens_models_desc	A list of vectors of text strings to show in the legends for sensitivity model plots, one name for each model, where the list elements represent a group of models
retro_models_desc	A list of vectors of text strings to show in the legends for retrospective model plots, one name for each model, where the list elements represent a group of models
...	Arguments to pass to create_rds_file()

Details

If any of the text lists are NULL, default description text will be assigned and a warning given. If the object "models" is already in existence, that will be used and only the names will be changed. This allows for easy and fast switching between French and English.

Value

A list of items, the base_model inside a single-element list, the list of bridge model groups, sensitivity model groups, request model groups, test model groups, and retrospective model groups. These groups are lists of models which are to be compared with each other in the document. This simplifies plotting and table functions

pbs-assess/gfiscamutils documentation built on Oct. 24, 2024, 1:37 p.m.