NONMEM Documentation Guide

website·Indexed 31 days ago

https://nmguides.vrognas.com

Technical reference and user guides for the NONMEM system, covering versions 7.2 through 7.6.0. Includes detailed documentation on NM-TRAN control records, estimation methods (FO, EM, MCMC Bayesian), differential equation solvers like LSODA (ADVAN13), probability density functions, and utility programs for analyzing $COV SIR data. Provides guidance on clinical trial design, nested random levels, and matrix algebra tools for parameter estimation.

Tokens
743.1K
Snippets
2.6K
Records
4.9K
Agent score
46%

What's inside NONMEM

  1. Overview of MCMC Bayesian Analysis in NONMEM

    Markov chain Monte Carlo (MCMC) Bayesian analysis in NONMEM is used to generate thousands of population parameter and variance parameter samples that represent their distribution based on the data fit. This serves as an alternative to bootstrap methods. While Bayesian analysis can be performed without prior information, it is recommended to provide prior information for OMEGA.
  2. Overview of NM-TRAN preprocessor

    NM-TRAN (NONMEM Translator) is a FORTRAN 90/95 preprocessor used before a NONMEM run. It simplifies the user's workflow by translating user-friendly inputs into the specific formats required by NONMEM. It produces three primary outputs:

    1. A NONMEM-compliant data set.
    2. A NONMEM control stream.
    3. Various subroutines (such as PRED) that must be included in a NONMEM load module.

    While NONMEM can be used without NM-TRAN, the preprocessor is strongly recommended, especially for beginners, as it handles the rigid formatting and complex subroutine generation automatically.

  3. Overview of NONMEM 7.6.0 nmhelp documentation categories

    The nmhelp system provides technical documentation for NONMEM 7.6.0, organized by file extension. Users can access these keywords via the command line using nmhelp <keyword>. The documentation is categorized as follows:

    • NM-TRAN Control Records (*.ctl): Documentation for records such as $THETA, $OMEGA, and $DATA.
    • Reserved Data Items (*.dat): Reference for data-record fields like AMT, EVID, MDV, and TIME.
    • Examples (*.exa): Reference example control streams.
    • File Reference (*.fil): Conventions for NONMEM input and output files.
    • Fortran / PRED State Variables (*.for): Runtime variables including ICALL, NEWIND, and COMACT.
    • General Concepts (*.gen): High-level explanations of individuals and error models.
    • Output Reference (*.out): Details on items found in the NONMEM output/report file.
    • PREDPP Reference (*.ppp): Documentation for ADVAN, SS, dose options, and TRANS.
    • Subroutine Stubs (*.stb): Stubs for CCONTR, CONTR, CRIT, MIX, and PRIOR.
    • Supplementary Topics (*.sup): NM7+ features including parallelism, XML, and table tools.
    • Utility Routines (*.utl): Reference for functions like RANDOM, PHI, CHOL, GAMLN, and SIMETA.
  4. Overview of NONMEM automatically generated output files

    NONMEM automatically creates several files based on the root name of the control stream file. The delimiter and numerical format of these files are determined by the $EST … FORMAT= specification. Key output files include:

    • root.cov: Full variance-covariance error matrix for THETAs, SIGMAs, and OMEGAs.
    • root.clt (NM74): Lower triangular form of the variance-covariance error matrix in TOSL order, intended for use as prior information in control stream files.
    • root.cor: Full correlation matrix for THETAs, SIGMAs, and OMEGAs.
    • root.coi: Full inverse covariance matrix (Fisher information matrix) for THETAs, SIGMAs, and OMEGAs.
    • root.grd (NM72): Gradient values for classical NONMEM methods.
    • root.xml (NM72): XML markup version of the NONMEM report file.
  5. Overview of the NONMEM Program architecture

    NONMEM is a batch-oriented computer program written in FORTRAN 90. It consists of several key components:

    • NM-TRAN: An input preprocessor that provides a SAS-like interface for user communication.
    • PREDPP: A suite of subprograms that implements common pharmacokinetic models and provides code for solving general linear and non-linear differential equations.
    • Estimation Methods: Users specify the dependence on mixed effects and choose an estimation method, each of which minimizes a different objective function.
  6. Overview of PREDPP in NONMEM

    PREDPP is a general-purpose implementation of the PRED subroutine in NONMEM, specifically designed for population pharmacokinetic (PK) data analysis. While its formal name in the calling program is PRED, it is informally known as PREDPP. It can be used for population analysis, single-subject analysis, and simulation of PK data.
  7. Overview of NONMEM abbreviated code syntax

    Abbreviated code is used in NM-TRAN control records (e.g., $PRED blocks) to specify the computation of model quantities. It is syntactically similar to FORTRAN, primarily using assignment statements, conditional statements, and arithmetic/logical expressions.

    Key characteristics include:

    • One statement per record: Each line in the control record can contain only one statement.
    • Case Insensitivity: Both upper and lower case may be used for user-defined and reserved words.
    • Comments: Comments are added using a semicolon (;).
    • Verbatim Code: An escape mechanism allows the insertion of raw FORTRAN code that is copied directly into the generated subroutine without being processed by NM-TRAN (meaning symbolic differentiation is not applied to it).
  8. Overview of NONMEM Version III Features

    NONMEM Version III introduces several key functional improvements over previous versions, including streamlined problem summaries, assistance in obtaining initial estimates for $\theta$, $|\Omega|$, and $\Sigma$, and the ability to make task specification records optional. Additionally, tables can now be stored in machine-readable files, and the objective function can be partially defined via user-code. A new simulation task allows users to simulate data based on a specified model, which can then be analyzed using estimation, covariance, tables, and scatterplot tasks.
  9. Overview of the NONMEM software suite

    NONMEM (Nonlinear Mixed Effects Model) is a computer program written in FORTRAN 90/95 used to fit general statistical nonlinear regression-type models to data. It is specifically designed for population pharmacokinetic analysis, allowing for the modeling of both fixed effects (measured concomitant effects) and random effects (unexplainable inter- and intra-subject effects). Unlike many regression programs, NONMEM does not have built-in models; it relies on a subroutine named PRED to compute predicted values and partial derivatives.
  10. Overview of PREDPP in NONMEM

    PREDPP is a general-purpose implementation of the PRED subroutine in NONMEM, specifically designed for population pharmacokinetic (PK) data analysis. While formally named PRED (the entry name used by NONMEM calling programs), it is informally called PREDPP. It is used to compute model-based predictions for observations and can be applied to population data, single-subject data, or simulations.
  11. Overview of MCMC Bayesian Analysis in NONMEM

    Markov chain Monte Carlo (MCMC) Bayesian analysis in NONMEM is used to generate thousands of population parameter and variance parameter samples that represent their distribution based on the data fit. This serves as an alternative to bootstrap methods. While the analysis can be performed without prior information, it is recommended to provide prior information for OMEGA.
  12. Overview of NONMEM and its components

    NONMEM (Nonlinear Mixed Effects Model) is a software package written in FORTRAN 90/95 used to fit general statistical nonlinear regression-type models to data. It is specifically designed for population pharmacokinetic (PK) data analysis, allowing for the modeling of both fixed effects (measured concomitant effects) and random effects (unexplainable inter- and intra-subject effects).

    The system consists of three primary components:

    1. NONMEM: The core engine that performs the statistical fitting. It does not have built-in models; instead, it calls a prediction subroutine (typically named PRED) to obtain predicted values and partial derivatives.
    2. PREDPP (PRED for Population Pharmacokinetics): A specialized PRED subroutine distributed with NONMEM. It contains a library of pharmacokinetic models and dosing regimens, removing the need for users to write their own FORTRAN subroutines for standard PK analysis.
    3. NM-TRAN (NONMEM Translator): A stand-alone control language translator and data preprocessor. It translates NM-TRAN records (lines starting with $) into the specific input files required by the NONMEM engine.