xpose4 (version 4.5.3)

summary: Summarize individual parameter values and covariates

Description

These functions produce tables, printed to the screen, summarizing the individual parameter values or covariates from a dataset in Xpose 4.

Usage

cov.summary(object,
            onlyfirst=TRUE,
            subset=xsubset(object),
            inclZeroWRES=FALSE,
            out.file=".screen", 
            main="Default",
            fill = "gray",
            values.to.use=xvardef("covariates",object),
            value.name="Covariate",
            ...)
                          
parm.summary(object,
            onlyfirst=TRUE,
            subset=xsubset(object),
            inclZeroWRES=FALSE,
            out.file=".screen",
            main="Default",
            fill = "gray",
            values.to.use=xvardef("parms",object),
            value.name="Parameter",
            max.plots.per.page=1,
            ...)

Arguments

object

An xpose.data object.

onlyfirst

Logical value indicating if only the first row per individual is included in the plot.

inclZeroWRES

Logical value indicating whether rows with WRES=0 are included in the plot. The default is FALSE.

out.file

Where the results should be output to. Can be ".screen", ".ask", ".graph" or a filename in quotes.

subset

A string giving the subset expression to be applied to the data before plotting. See xsubset.

main

The title of the plot. If "Default" then a default title is plotted. Otherwise the value should be a string like "my title" or NULL for no plot title. For "Default" the function xpose.multiple.plot.title is used.

fill

The color to fill the boxes in the table if the table is printed to ".graph"

values.to.use

Which values should be summarized

value.name

The name of the values

max.plots.per.page

Maximum plots per page.

…

Other arguments passed to Data and SData.

Value

Returned is the matrix of values from the table. parm.summary and cov.summary produce summaries of parameters and covariates, respectively. parm.summary produces less attractive output but supports mirror functionality.

parm.summary and cov.summary utilize print.char.matrix to print the information to the screen.

See Also

Data, SData, xpose.data-class, print.char.matrix

Examples

## We expect to find the required NONMEM run and table files for run
## 5 in the current working directory
xpdb5 <- xpose.data(5)


## Here we load the example xpose database 
data(simpraz.xpdb)
xpdb <- simpraz.xpdb

parm.summary(xpdb)

cov.summary(xpdb)