A list of item labels (i.e., user-chosen item types) to be tabled along with DV and the special items PRED, RES, and WRES. The user may request the following additional special diagnostic items by including their name in the list.

• NPRED, NRES, NWRES Calculated assuming non-conditional estimation and no etaepsilon interaction. NPRED and NRES are same as PRED and RES. NWRES is same as WRES when INTERACTION is not set in $EST.
• PREDI, RESI, WRESI. Calculated assuming non-conditional estimation with etaepsilon interaction. Always same as PRED, RES, and WRES.
• CPRED, CRES, CWRES. Calculated assuming conditional estimation and no etaepsilon interaction.
• CPREDI, CRESI, CWRESI. Calculated assuming conditional estimation with eta-epsilon interaction.
• CIPRED, CIRES,CIWRES. Conditional individual values
• CIPREDI, CIRESI,CIWRESI. Conditional individual values with eta-epsilon interaction.
• EPRED, ERES, EWRES. Monte-Carlo generated diagnostics and are not linearized approximations like the other diagnostic types. EWRES is the Monte-Carlo version of CWRESI.
• ECWRES. Monte-Carlo version of CWRES.
• NPDE. Monte-Carlo generated normalized probability distribution error.
• NPD. The correlated (or non-decorrelated) NPDE value.
• OBJI. Objective function values for each individual (same as given in the root.phi file). The sum of the individual objective function values is equal to the total objective function.

In addition the list may include:

1

  ETAS(k:n)

1

  ETAk, ..., ETAn

1
2

  ETAS(1 TO 10 by 3)    ;! ETAs 1,4,7,10
  ETAS(LAST TO 1 by -3) ;! ETAs 10,7,4,1 (assuming LAST=10)

1
2
3
4

  ETAS(1,5,12,4)  ;! prints out ETAs 1, 5, 12, 4.
  ETAS(4:1)	  ;! prints ETAs 4, 3, 2, 1
  ETAS(4:1 by -2) ;! prints ETAs 4, 2
  ETAS(1:4 by -1) ;! prints ETAs 4, 3, 2, 1 (the by value sets the direction).

1
2
3

  $ABBR REPLACE ETA(CL)=ETA(1)
   ...
  $TABLE ETA(CL)

1
2
3
4
5
6
7

   0nnn     e.g., 0010   ;# stands for A00nnn
   1nnn     e.g., 1010   ;# stands for A01nnn
   2nnn     e.g., 2010   ;# stands for C00nnn
   3nnn     e.g., 3010   ;# stands for D00nnn
   4nnn     e.g., 4010   ;# stands for E00nnn
   5nnn     e.g., 5010   ;# stands for F00nnn
   6nnn     e.g., 6010   ;# stands for P00nnn

1

  WRES=RES1,IWRES=RES2,COM(3)=ABC,0032=DK.

1
2

;# example
$TABLE G11 G21 G31 H11 H21

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

    $ABB COMRES=5
    "LAST
    "  COM(1)=G(1,1)
    "  COM(2)=G(2,1)
    "  COM(3)=G(3,1)
    "  COM(4)=HH(1,1)  (or H(1,1) with $PRED)
    "  COM(5)=HH(2,1)  (or H(2,1) with $PRED)
  $TABLE ID COM(1)=G11 COM(2)=G21 COM(3)=G31
   COM(4)=H11 COM(4)=H21
   IPRED MDV NOPRINT ONEHEADER FILE=cwtab1

1
2

 $TABLE ID G11 G21 G31 H11 H21
  IPRED MDV NOPRINT ONEHEADER FILE=cwtab1

A list comprised of one or more labels from list1. The rows of the table are sorted on the data items in list2. List2 may not appear when the number of labels in list1 is greater than 8. That is, a table with more than 8 data items also may not be sorted.

With NOSUB=0, label substitution will be performed for final estimates in table files. (See $ABBREVIATED). This is the default. With NOSUB=1, label substitution will not be performed.

A list comprised of one or more items that are permitted in list1, e.g., data item labels and labels of PRED-defined items in MODULE NMPRD4. They follow option EXCLUDE_BY. Labels in list3 are called exclusion variables. If one or more of them have a non-zero value for a given data record, the row of the table corresponding to the data record will be excluded from the table file. Exclusion variables are not listed in the table file. They have no effect on the printed table or scatters in the NONMEM output, e.g., they do not cause any rows to be deleted from the printed table and are displayed in the printed table.

Weighted residuals are evaluated before the first $TABLE record. As of NONMEM 7.4, this computation is parallelized if parallelization is on when the first Table Step is implemented. PARAFILE=filename specifies a different parafile than was used for the previous step.

PARAFILE=ON turns on parallelization for the weighted residuals.

PARAFILE=OFF turns off parallelization for the weighted residuals. The PARAFILE option may be specified on any $TABLE record, but applies to all $TABLE records.

n1 specifies the number of random samples used to calculate the Monte-Carlo diagnostics. Should be specified only on the first $TABLE record. Default is 300.

Use the Cholesky square root of the variance, rather than the eigenvalue square root, when computing weighted residuals. Should be specified only on the first $TABLE record. This can speed up the Table Step when there are a large number of observations per individual.

n2 specifies the starting seed for generating the Monte-Carlo diagnostics. Should be specified only on the first $TABLE record. Default is 11456.

If CLOCKSEED=1 (default is 0), actual starting seed will be 10000*(seconds after midnight)+SEED. This allows a control stream to produce different stochastic results for automated replications, without the need to modify the seed value in the control stream file in each replication.

• n: the random number generator used for the Monte-Carlo simuations of weighted residual items.

  • 0: ran0 of reference [5], minimal standard generator
  • 1: ran1 of reference [5], Bays and Durham.
  • 2: ran2 of reference [5].
  • 3: ran3 of reference [5], Knuth. (Default)
  • 4: NONMEM's traditional random number generator used in $SIMULATION
• S: sobol sequence

• m: the type of scrambling desired

  • 0: no scrambing (S0 is the same as S)
  • 1: Owen type scrambling
  • 2: Faure-Tezuka type scrambling
  • 3: Owen plus Faure-Tezuka type scrambling.

See $ESTIM RANMETHOD option.

Among the Sobol sequence methods, the S2 method appears to provide the least biased random samples, that is nearly uniform distribution, with good mixing in multi-dimensional spaces.

RANMETHOD should be specified only on the first $TABLE command. The RANMETHOD set in the $TABLE command does not propagate to $EST or $CHAIN.

Options PRINT, NOPRINT, HEADER, NOHEADER, NOLABEL, NOTITLE, FILE, FIRSTONLY, LASTONLY,FIRSTLASTONLY, FORWARD, NOFORWARD, APPEND, NOAPPEND, FORMAT, VARCALC apply to the individual $TABLE record. They must be specified for each table to which they apply.

PRINT: a printed table appears in the NONMEM output. This is the default.

NOPRINT: no printed table appears in the NONMEM output.

The table is written to the given file in character form, e.g., ASCII or EBCDIC, according to the hardware platform. Filename may not contain embedded spaces. If it contains commas, semi- colons, or parentheses, then it must be surrounded by single quotes ' or double quotes ". Filename may also contain equal signs if it is enclosed in quotes. Filename may contain at most 71 characters. If filename is the same as any option of the $TABLE record, it must be enclosed in quotes. Filename can differ between $TABLE records. Default: No table file is output. Required with NOPRINT.

NOHEADER: used only with the FILE option. No header lines are included in the table file.

ONEHEADER: used only with the FILE option. Only the first line of the table is a header line.

Used only with the FILE option and FORWARD. Only the first line of the table file is a header line. May also be coded ONEHEADERPERFILE.

Used only with the FILE option. Do not print column labels. It may be combined with ONEHEADER to print only the title at the beginning of each table.

Used only with the FILE option. Do not print table titles. It may be combined with ONEHEADER to print only the column labels at the beginning of each table. NOLABEL NOTITLE is equivalent to NOHEADER.

FIRSTONLY: only information corresponding to the first data record from each individual record appears in the table. May also be coded FIRSTRECORDONLY or FIRSTRECONLY.

LASTONLY: only information corresponding to the last data record from each individual record appears in the table. May also be coded LASTRECORDONLY or LASTRECONLY.

FIRSTLASTONLY: only information corresponding to the first and last data record from each individual record appears in the table.

FORWARD: Used only with the FILE option. When a table file is opened during a given (sub)problem, it is forwarded to the end of the file. This allows a table file to accumulate tables from multiple subproblems and superproblems. Moreover, if in the same (sub)problem the $TABLE record is followed by a contiguous succession of additional $TABLE records having the same filename as the given record, then even though some of these additional records may have the NOFORWARD option, or have neither the NOFORWARD nor the FORWARD options, the FORWARD option will apply to each of the records in the succession.

NOFORWARD: used only with the FILE option. When the table file is opened during a given (sub)problem, it is positioned at the start of the file. This is the default. However, when there are multiple $TABLE records within the same problem and having the same filename, the situation is a little more complicated;

APPEND: items DV, PRED, RES, WRES appear automatically as the last 4 columns of the table. This is the default.

NOAPPEND: requests that items DV, PRED, RES, WRES not appear automatically. When this is specified, the number of labels (i.e., user-chosen item types) that may appear in the table can be as large as 12 (rather than 8) for a printed table, and as large as PDT=4 (rather than PDT) for a table file. If items PRED, RES, and/or WRES are explicitly coded in list1, then they appear in the table, exactly as listed. (Previously to NONMEM VI 2.0, they could be included in the list, but were suppressed from the portion of the table described by list1 in favor of the automatically-generated items.)

This option defines the delimiter and number format for table files. It affects table files until a different FORMAT is specified. s defines the delimiter [,|s(pace)|t(ab)] followed by a Fortran format specification. The default is s1PE11.4. There are many more options for FORMAT.

For more details, see the format help:

Alternately, use LFORMAT and/or RFORMAT.

Specifies the format of the full label record of a table. Allows different formats for different columns. Sample:

1

LFORMAT="(4X,A4,4(',',4X,A8))"

Specifies the format of the full numeric record of a table. Allows different formats for different columns. Sample:

1

RFORMAT="(F8.0,,4(',',1PE12.5))"

Multiple LFORMAT options and RFORMAT options may be present and will be concatenated. The format specifications are not checked by NMTRAN. If either is invalid, the run will fail in NONMEM. Both LFORMAT and RFORMAT affect table files until a different format is specified. Use LFORMAT="NONE" or RFORMAT="NONE" to resume use of the default format (which may have been specified by the FORMAT option) in a subsequent problem.

By default the ID column has the same format as specified by FORMAT. IDFORMAT specifies the format for the ID column in table files. If an improper format is given, it defaults to that of FORMAT. For example

• IDFORMAT=I. Integer value, left adjusted in the field.
• IDFORMAT=I6. Integer value, right adjusted in the first 6 characters of the field.
• IDFORMAT=F6.1. Floating value, with single digit to the right of the decimal.

To report standard errors associated with ETAs (individual parameters) in the tables for user-defined variables, set (see "examples/setest")

1

$TABLE ...VARCALC=1

This appends an item named item_SE following each user-defined item in list1. If using RFORMAT formatting option, make sure to allow enough format fields to include reported standard errors. In addition, full variances-covariances among all user-defined variables and PREDPP parameters will be outputted to file root.vpd (the FORMAT used for this file is that defined in the $EST statement). With NONMEM 7.5, file root.vpt is also created. This contains variance-covariances associated with THETAs (or OMEGAs and SIGMAs) as well as those associated with ETAs/individual parameters. To append the comparable total standard errors item_SE to tables, set $TABLE ...VARCALC=3. To only create the vpd and vpt files, and not report SE's to the table, set VARCALC=2. This option must be re-coded for each $TABLE record for which SE's are wanted. If VARCALC=1 or 2 or 3 is requested at least once among any of the tables, then the variance items are written to the vpd and vpt files. VARCALC=0 requests neither SE's nor vpd nor vpt, and is the default. Values of COMACT, which identify copying passes, may need to be tested in abbreviated code when this feature is used.

The variances are based on variance-covariance of the ETAs/PHIs in the .phi file, centered about the values reported in the table files.

• For classical NONMEM methods, this means variables are centered at the ETA mode.

• For EM methods:

  • FNLETA=1,3: variance-covariance of ETAs from last iteration of last estimation method is used, and centered about FNLETA based evaluations of variables (MAP, ETA mode).
  • FNLETA=0: variance-covariance of ETAs from last iteration of last estimation method is used, and centered about method based evaluations of variables (conditional means for EM methods, conditional modes for classical and ITS methods, MCMC posterior means for BAYES).
  • FNLETA=2: variance-covariance, and ETAs used for assessing variables are obtained from external source.

The standard errors in the .vpt table are most accurately assessed if the problem is MU modeled. If it is not MU modeled, then only standard errors of variables that do not vary with ETAs (variables derived exclusively from THETAs, for example), are assured to be correctly calculated. It also takes into account that the .phi tables contain variances to phi’s and ETAs under fixed theta conditions for all methods except BAYES, where the variances to phis or ETAs are sampled under varying theta conditions.

Note that to obtain the PRED and its error, one should define a variable that is based on IPRED, but evaluated only when COMACT=1 (NONMEM passes through the model system with ETA=0):

1
2

IPRED=F
If(COMACT==1) PREDU=IPRED

So, PREDU is IPRED evaluated with ETA=0. Then, list this in a table:

1

$TABLE …  PREDU … VARCALC=3

Keep in mind that PREDU has only statistical errors associated with THETAS (and SIGMAS, depending on how PREDU is evaluated, based on the variance-covariance in the .cov file), and not ETAs (the phc() variances in the .phi file do not contribute to PREDU, since ETAs=0 when COMACT=1), so VARCALC=3 is required. No statistical errors are evaluated for weighted residual diagnostics (WRES, NPD’s, etc).

The vpd and vpt files contain entries for each COMACT the NONMEM used to calculate the table items. For the vpd file, variance-covariance among user-defined variables and PREDPP variables are placed in this file, associated with individual variances of the .phi file. The COMACT column value is usually 2, or 3 if $NONPARAMETRIC ETAS was implemented. The subsequent columns contain the values of user-defined table items, followed by variance-covariance of these items (labeled VAR1_VAR2, where VAR1 and VAR2 are the particular table items).

For the vpt file, the total variance-covariance among user-defined variables and PREDPP variables are placed in this file, associated with individual variances of the .phi file, as well as the variance-covariance of the fixed effects variables (THETAS, SIGMAS, OMEGAS) of the .cov file. The COMACT column value is 1 to indicate the record contains the values during a COMACT=1 pass, that is with ETAs set to 0. Thus, an individual predicted value (IPRED) on this record would in fact by the population predicted value (PRED). The subsequent columns contain the values of user-defined table items, followed by variance-covariance of these items (labled VAR1_VAR2, wher VAR1 and VAR2 are the particular table items). The variance IPRED_IPRED for a record with COMACT=1 would then have essentially the statistical error associated with the variance-covariance of the appropriate THETAs. If you are satisfied to pick up the PRED values and their errors from the vpt table, then it is not necessary to define a COMACT=1 evaluated variable in the control stream, as you can get it from IPRED on the COMACT=1 rows in the .vpt table. But if you want the appropriate PRED variable with standard error presented in the user-requested $TABLE table, then the PREDU must be defined as above. For non-parametric estimated ETAs, when $NONPARAMETRIC ETAS is used, then a COMACT 3 pass will be made, and their values will be presented in the vpt table with the COMACT set to 3.

Example "examples/predu" prints out IPRED, PRED, and PREDU in the various tables (predu.tab, predu.phi, predu.cov, predu.vpt, predu.vpd), and one can compare their values and associated standard errors.

Specified ETAs may be treated as if they are fixed effects when evaluating population diagnostics during the $TABLE step. This is particularly suitable for super-ID $LEVEL ETAs that span groups of subjects, as if they were a fixed effect when evaluating populations characteristics during the $TABLE step, such as PRED, CWRES, NPDE, etc. In this way, the PRED evaluated will be, not of the total population, but of a given site level for that subject. List is a number-list of ETAs. For example,

1

FIXEDETAS=(3-6)

A number-list may contain a single integer, a range of integers (with -), or a series of integers and ranges separated by comma.

The strict stochastic (Monte Carlo) method over the data y domain as well as ETAs is implemented for NPD diagnostics.

An asymptotic assessment of the residual variability is used. This is the default.

By default the interpolation for NPD/NPDE evaluations type is 0, that is, the nearest value in the quantile area is chosen, without interpolation. If INTERPTYPE=1, then an interpolation is performed using an inverseNORM linearized interpolator. In addition, for NPDE it will extrapolate quantile positions that are outside the Monte Carlo sampled range, allowing severe outliers to be less truncated. For example, by default, if the EXAMPLE=300, and a quantile position is 0.001, then the 1/300 value is returned, the lowest value from 300 samples. With INTERPTYPE=1, an extrapolation is performed to better represent the 0.001 value, and will be less than the lowest value among 300 samples simulated. The INTERPTYPE has less impact with increasing ESAMPLE.

UNCONDITIONAL: the Table Step is always implemented. This is the default.

CONDITIONAL: the Table Step is implemented only when the Estimation Step terminates successfully or is not implemented.

The Table Step is not implemented.