Learn R Programming

xpose4 (version 4.5.3)

xpose.prefs-class: Class "xpose.prefs"

Description

An object of the "xpose.prefs" class holds information about all the variable and graphical preferences for a particular "xpose.data" object.

Arguments

Objects from the Class

Objects can be created by calls of the form new("xpose.prefs",...) but this is usually not necessary since the "xpose.prefs" object is created at the same time as the "xpose.data" object.

Slots

Xvardef:

Object of class "list"A list with the Xpose variable defintions. The values of the list are strings with the name of one or more columns in the data frames of Data or SData (xpose.data-class).

To get a listing of the current variable definitions in a particular "xpose.data" object type: object@Prefs@Xvardef on the command line (object is the name of the xpose.data object). These definitions have default values that are adjusted to reflect the contents of the Data slot in the xpose.data object when the object is initialized. Look in the createXposeClasses function for the default values.

To access a specific variable defintion, use object@Prefs@Xvardef[["vardef"]], where vardef is the name of the Xpose variable. You can also use the utility function xvardef.

Labels:

Object of class "list" A list that translates column headers in Data and SData to labels to be used in graphs, e.g. "TIME" to "Time (h)". This is used in the labelling of axes, for example.

To get a listing of the current labels in a particular "xpose.data" object type: object@Prefs@Labels on the command line (object is the name of the xpose.data object). These definitions have default values that are adjusted to reflect the contents of the Data slot in the xpose.data object when the object is initialized. Default Labels that are not present in the NONMEM table files are deleted and columns that are present in the table files but that do not have default Label get a Label that is the same as the column name. Look in the createXposeClasses function for the default values.

To access a specific variable defintion, use object@Prefs@Label[["name"]], where name is the name of the column in the NONMEM table files. You can also use the utility function xlabel to access the labels.

The label for a particular column can also be changed using the xlabel function.

Graph.prefs:

Object of class "list" This is a list with graphical parameters for the various elements in the Xpose graphs.

To get a listing of the current graphical preferences in a particular "xpose.data" object type: object@Prefs@Graph.prefs on the command line (object is the name of the xpose.data object).

Look in the createXposeClasses function for the default values and some comments.

Miss:

Object of class "numeric" This is a scalar value that indicate missing values in the NONMEM table files. The default is -99. Can be accessed by object@Prefs@Miss.

Cat.levels:

Object of class "numeric" This value is used when an "xpose.data" object is created. Any variable from a NONMEM table file that has fewer than or equal number of unque value tha Cat.levels are converted to factors. The default value is 4.

DV.Cat.levels:

Object of class "numeric" This value is used when an "xpose.data" object is created. If a variable from a NONMEM table file with the name DV has fewer than or equal number of unque value than DV.Cat.levels are converted to a factor. The default value is 7.

Subset:

Object of class "character or NULL" A string that indicates the subset of the data to use in a plot. An example is SEX==1. This string is used by the Data and SData functions when extracting the data to plot from an "xpose.data" object. Note that it is not used in the subset argument to xyplot. The value of Subset can be accessed and changed using the xsubset function.

Gam.prefs:

Object of class "list" This is a list containing preferences for the general additive model (GAM).

To get a listing of the current graphical preferences in a particular "xpose.data" object type: object@Prefs@Gam.prefs on the command line (object is the name of the xpose.data object).

Look in the createXposeClasses function for the default values, and see also xpose.gam.

Methods

No methods defined with class "xpose.prefs" in the signature.

See Also

xvardef, xlabel, xsubset, Data, SData, xpose.data, read.nm.tables, xpose.data-class, xpose.gam