read_model: Creates a model object from a YAML model file

In metrumresearchgroup/mrgvalidatetestreference: Test reference for mrgvalidate

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, .directory = get_model_directory())

Arguments

.path	Path to the YAML file to parse. MUST be either an absolute path, or a path relative to the '.directory' argument.
.directory	Model directory which ‘.path' is relative to. Defaults to 'options(’rbabylon.model_directory')', which can be set globally with 'set_model_directory()'.

Value

S3 object of class 'bbi_.model_type_model'

metrumresearchgroup/mrgvalidatetestreference documentation built on Aug. 15, 2021, 8:13 a.m.