dollar: Get/set existing subroutine

In tsahota/NMproject: Script Based 'NONMEM' Model Development

Get/set existing subroutine

Description

The fast way to see the contents of a particular subroutine directly in the R console. It can also be used to set the contents of a NONMEM subroutine in place of manual edits

Usage

dollar(m, dollar, ..., add_dollar_text = TRUE)

Arguments

m	An nm object.
dollar	Character. Name of NONMEM subroutine to target.
...	Additional arguments to be passed to text(). If specified these will set the contents of the subroutine. See examples below.
add_dollar_text	Logical (default = TRUE). Should the $XXXX string be added to text.

Value

If dollar is specified returns the relevant subroutine of the control file as a character. Otherwise returns an nm object with modified ctl_contents field.

See Also

insert_dollar(), delete_dollar()

Examples

# create example object m1 from package demo files
exdir <- system.file("extdata", "examples", "theopp", package = "NMproject")
m1 <- new_nm(run_id = "m1", 
             based_on = file.path(exdir, "Models", "ADVAN2.mod"),
             data_path = file.path(exdir, "SourceData", "THEOPP.csv"))

m1 %>% dollar("PK") ## displays existing $PK

m1 %>% dollar("THETA")

c(m1, m1) %>% dollar("THETA") # display $THETAs for multiple NONMEM runs

tsahota/NMproject documentation built on April 13, 2025, 4:38 p.m.