___________________________________________________________________
| |
| $ABBREVIATED |
|_________________________________________________________________|
MEANING: Provides instructions about abbreviated code
CONTEXT: NM-TRAN Control Record
USAGE:
$ABBREVIATED [COMRES=n1] [COMSAV=n2] [DERIV2=NO] [DERIV2=NOCOMMON]
[DES=COMPACT|DES=FULL]
SAMPLE:
$ABBREVIATED COMRES=2
DISCUSSION:
Optional. May be used when $PK, $ERROR, or $PRED abbreviated code is
present. Must precede all blocks of abbreviated code.
OPTIONS:
COMRES=n1 ('common reserve')
COMRES gives instructions to NM-TRAN.
Values of n1:
-1 Do not store any variables in the global common NMPRD4
0 Store variables in NMPRD4 with no reserved positions (the
default)
n1>0 Store variables in NMPRD4, but reserve the first n1 posi-
tions
With abbreviated code, the Ith position in NMPRD4 is referenced
by COM(I).
This option is intended for advanced users of NONMEM, e.g., when
abbreviated code is combined with user-supplied subroutines or
verbatim code. A user-supplied subroutine may reserve the first
n1 positions in NMPRD4 for its use, in which case the option
COMRES should be set to n1 to instruct NM-TRAN to skip these
positions; the first position used by NM-TRAN for storing vari-
ables defined in abbreviated code will be position {n1}+1.
$TABLE and $SCATTER may explicitly reference variables in
reserved positions 1 through n1 by COM(1) through COM(n1),
respectively, in addition to listing variables defined in abbre-
viated code by name.
An individual block of abbreviated code (e.g. $PK) may include
the pseudo-statement COMRES=-1, which prevents any variable
defined in that particular block from being stored in common
NMPRD4.
COMSAV=n2 ('common save')
Values of variables displayed in tables and scatterplots are
obtained from common NMPRD4. There are particular times when
data records are passed to PRED for the purpose of obtaining
these values; these are called copying passes. The SAVE region
of common NMPRD4 is the initial part of NMPRD4. If a variable is
stored in the SAVE region, then the value of the variable com-
puted with a given data record during a copying pass will be
found in NMPRD4 when the same record is passed during the next
copying pass, i.e. it will have been saved from the previous
copying pass. This is in contrast to the usual behaviour, where
with a given data record, the value in NMPRD4 is the value com-
puted with the previous data record.
n2 is the initial size of the SAVE region, i.e. the number of
positions in this region. n2 =0 is the default value. n2 may
not exceed n1.
The SAVE region has size n2 initially, but NM-TRAN may extend it
if SAVE variables are used. However, if n2 =-1, the SAVE region
is not to be extended, and there is to be no SAVE region alto-
gether.
(See copying block).
When PREDPP is used, and a $PK block is present, NM-TRAN inserts
code into the PK routine that stores the value of COMSAV in
NMPRD3 at ICALL=1. If no $PK block is present, and a $ERROR
block is present, the code is inserted into the ERROR routine.
When PREDPP is not used, and a $PRED block is present, the gen-
erated or library PRED routine stores the value of COMSAV in
NMPRD3 at ICALL<=1.
DERIV2=NO
Prevents the computation of second derivatives, which are needed
only for the Laplacian method.
With $ESTIMATION METHOD=COND LAPLACIAN, this option may not be
specified.
DERIV2=NOCOMMON
Permits the computation of these derivatives, but prevents them
from being stored in the global common NMPRD4.
$ESTIMATION METHOD=COND LAPLACIAN may be specified, but variables
representing second derivatives are not stored in common NMPRD4.
Therefore, they cannot be displayed in tables and scatterplots.
In addition, no variables computed in the $PK block may be refer-
enced in the $ERROR block. This is true whether or not these
variables happen to have second derivatives, and whether or not
the Laplacian method is used.
DES=FULL
Arrays of the DES routine are stored in non-compact form.
With $ESTIMATION METHOD=COND LAPLACIAN, the option NUMERICAL is
also required.
DES=FULL is the default with ADVAN9.
DES=COMPACT
Arrays of the DES routine are stored in compact form.
Required with Laplacian method; optional otherwise. This is the
default, except with ADVAN9.
REFERENCES: Guide III Section V.2.7
REFERENCES: Guide IV Section III.B.7, IV
Go to main index.
Created by nmhelp2html v. 1.0 written by Niclas Jonsson (Modified by AJB 5/2006,11/2007)