nmtran_setup: Sets up 'NM-TRAN' to run by identifying an 'NM-TRAN'...

View source: R/run-nmtran.R

nmtran_setupR Documentation

Sets up NM-TRAN to run by identifying an NM-TRAN executable for a provided NONMEM version and formatting arguments based on .bbi_args, the corresponding .mod yaml file, and any nmfe_options defined in a bbi.yaml file

Description

Sets up NM-TRAN to run by identifying an NM-TRAN executable for a provided NONMEM version and formatting arguments based on .bbi_args, the corresponding .mod yaml file, and any nmfe_options defined in a bbi.yaml file

Usage

nmtran_setup(
  .mod,
  .bbi_args = NULL,
  .nonmem_version = .bbi_args[["nm_version"]],
  .config_path = NULL
)

Arguments

.mod

A bbi_nonmem_model object.

.bbi_args

A named list specifying arguments to pass to NM-TRAN. Similar to the .bbi_args argument defined in submit_model(), though here only prdefault, tprdefault, and maxlim arguments are passed to NM-TRAN. nm_version is also supported and specifies which NM-TRAN executable to use. See print_bbi_args() for more details.

.nonmem_version

Character scalar for default version of NONMEM to use. If left NULL, will look for the default version specified in the provided bbi configuration file.

.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.


metrumresearchgroup/bbr documentation built on March 29, 2025, 1:08 p.m.