nm_prior: Generate a NONMEM control stream with $PRIOR

In pnolain/pmxploit: Pharmacometric tools for post-processing of mixed-effects models for continuous data

Generate a NONMEM control stream with $PRIOR

Description

Generates a NONMEM control stream for an analysis using prior information from a source run.

Usage

nm_prior(
  run,
  df_formula = 0,
  df_values = NULL,
  output_file = NULL,
  dataset_filename = NULL,
  estimations = NULL
)

Arguments

run	pmxploit NONMEM run object of the source run.
df_formula	integer. Formula to use for computation of degrees of freedom of OMEGA and SIGMA priors.
output_file	(optional) character. File path to write the generated control stream to. Default is NULL, not saving any file.
dataset_filename	(optional) character. Name of the dataset to set in the $DATA record of the generated control stream. Default is NULL, leaving $DATA record as it is in the source run.
estimations	(optional) list. A list containing the estimation record(s) to set for the generated control stream. Each estimation record must be represented by a list item containing the estimation settings as a named list.

Value

A character string of the generated control stream code.

Examples

# Control stream generation from pmxploit::EXAMPLERUN
cs1 <- nm_prior(EXAMPLERUN)
# see the output
writeLines(cs1)

# Use prior information with "new_dataset.csv" and save the control stream to "new_study.ctl"
nm_prior(EXAMPLERUN, output_file = "new_study.ctl", dataset_filename = "new_dataset.csv")

# Use prior information with "new_dataset.csv", set estimation to SAEM/IMP and
# save the control stream to "new_study.ctl"
nm_prior(EXAMPLERUN,
         output_file = "new_study.ctl",
         dataset_filename = "new_dataset.csv",
         estimations = list(list(method = "SAEM",
                                 "INTERACTION", NBURN = 400, NITER = 1000,
                                 PRINT = 50, "NOABORT", CTYPE = 3),
                            list(method = "IMP",
                                 NITER = 10, PRINT = 1,
                                 ISAMPLE = 3000, EONLY = 1)))

pnolain/pmxploit documentation built on Jan. 31, 2024, 1:16 p.m.