pmx_read_nm_model: NONMEM model file parser

View source: R/pmx_read_nm_model.R

pmx_read_nm_modelR Documentation

NONMEM model file parser

Description

Parse NONMEM model files in R format

Usage

pmx_read_nm_model(
  runno = NULL,
  prefix = "run",
  ext = ".lst",
  file = NULL,
  dir = NULL
)

Arguments

runno

run number which is used for generating the model file name

prefix

Prefix to be used to generate model file name. Used in combination with runno and ext.

ext

Extension to be used to generate model file name. Should be one of'.lst' (default), '.out', '.res', '.mod' or '.ctl' for NONMEM.

file

A character vector of path to the files or a nm_table_list object created with list_nm_tables.

dir

directory of the model files.

Value

A tibble of class model containing the following columns:

  • problem: a numeric identifier for the $PROBLEM associated with the code.

  • level: a unique numeric identifier to each subroutine block associated with the code.

  • subroutine: a character identifier named after the 3 first letters of the subroutine name e.g. '$THETA' and '$TABLE' will become 'the' and 'tab' respectively. In addition all output from the .lst is labeled 'lst', the general nonmem output e.g. NM-TRAN messages are labelled 'oth'. With priors thp, tpv, omp, opd, sip, spd abbreviations are given to the THETAP, THETAPV, OMEGAP, etc.

  • code: the code without comments or subroutine names e.g. '$THETA 0.5 ; TVCL' will return '0.5'.

  • comment: the last comment of a record e.g. '0.5 ; Clearance (L/h) ; TVCL' will return 'TVCL'.

See Also

pmx_read_nm_tables

Examples

## Not run: 
# Using the `file` argument to import a model file:
nm_model <- pmx_read_nm_model(file = 'run001.lst', dir = 'models')

# Using the `runno` argument to import a model file:
nm_model <- pmx_read_nm_model(runno = '001', ext = '.lst', dir = 'models')

## End(Not run)


ggPMX documentation built on June 18, 2022, 1:05 a.m.