new_model.Rd
Creates new model object by specifying relevant information as arguments.
Also creates necessary YAML file for using functions like add_tags()
and
run_log()
later. Will look for an associated model file (control stream) on
disk and throw an error if it doesn't find one.
new_model( .path, .description = NULL, .based_on = NULL, .tags = NULL, .bbi_args = NULL, .overwrite = FALSE, .model_type = c("nonmem") )
.path | Path to save the new model. Will be the path to the model file and YAML file (both without extension), and the path to the output directory. |
---|---|
.description | Character scalar description of new model run. This will
be stored in the yaml (and can be viewed later in |
.based_on | Character scalar or vector of paths to other models that
this model was "based on." These are used to reconstuct model developement
and ancestry. Paths must be relative to |
.tags | A character scalar or vector with any user tags to be added to the YAML file |
.bbi_args | A named list specifying arguments to pass to babylon
formatted like |
.overwrite | If |
.model_type | Character scaler to specify type of model being created
(used for S3 class). Currently only |
S3 object of class bbi_{.model_type}_model
that can be passed to
submit_model()
, model_summary()
, etc.