Model submission consists of two steps: generating the initial values (METHOD=CHAIN run) and sampling for each chain (METHOD=BAYES or METHOD=NUTS runs).

# S3 method for class 'bbi_nmbayes_model'
submit_model(
  .mod,
  .bbi_args = NULL,
  .mode = getOption("bbr.bbi_exe_mode"),
  ...,
  .overwrite = FALSE,
  .config_path = NULL,
  .wait = TRUE,
  .dry_run = FALSE
)

Arguments

.mod

The model object to submit.

.bbi_args

A named list specifying arguments to pass to bbi formatted like list("nm_version" = "nm74gf_nmfe", "json" = T, "threads" = 4). Run print_bbi_args() to see valid arguments. Note that bbr does not support changing the output directory (including through the model or global YAML files).

.mode

Mode for model submission: "local", "sge", or "slurm". If unspecified, the value is set to the value of the bbr.bbi_exe_mode option. This option defaults to "sge" on Linux and "local" otherwise.

...

args passed through to bbi_exec()

.overwrite

Whether to overwrite an existing output directory. Note that, unlike the submission method for regular bbi_nonmem_model objects, this method does not inspect .bbi_args or bbi.yaml when the value is NULL; any value other than TRUE is treated the same as FALSE.

.config_path

Path to a bbi configuration file. If NULL, the default, will attempt to use a bbi.yaml in the same directory as the model.

.wait

If TRUE, the default, wait for the bbi process to return before this function call returns. If FALSE function will return while bbi process runs in the background.

.dry_run

Do not submit the sampling runs; just report what command would be executed via the returned object. Note: The METHOD=CHAIN model is executed to generate the initialization values regardless of this value.

See also

bbr_nmbayes for a high-level description of how NONMEM Bayes models are structured