read_model: Creates a model object from a YAML model file

View source: R/new-model.R

read_modelR Documentation

Creates a model object from a YAML model file

Description

Parses a model YAML file into a list object that contains correctly formatted information from the YAML and is an S3 object of class ⁠bbi_{.model_type}_model⁠ that can be passed to submit_model(), model_summary(), etc.

Usage

read_model(.path)

Arguments

.path

Path to the model to read, in the sense of absolute model path. The absolute model path is the path to the YAML file and model file, both without extension, and (possibly) the output directory.

Value

S3 object of class ⁠bbi_{.model_type}_model⁠

See Also

copy_model_from(), new_model()


metrumresearchgroup/rbabylon documentation built on April 21, 2024, 3:26 a.m.