nmScatterPlot: NONMEM scatter plot

Description Usage Arguments Format Value Author(s) Examples

Description

Generates a set of scatter plots with features that are tailored for PK/PD data generated by NONMEM.

Usage

1

Arguments

obj

An object of class NMRun, NMProblem, or data.frame. The object from which data will be plotted.

xVars

Single string with name of x-axis variable.

yVars

Variables to plot on the y-axes, specified as a comma separated string or character vector

bVars

"Trellis" variables on which to split data.

gVars

"Grouping" variable – used to group points by colour, for legends and so on.

iVars

Variable name of the "inherent grouping" (subject identifier) variable. This affects plots whose type is "l", "i", "o" or "t". Lines will be grouped by this variable in addition to any other grouping (e.g. in gVar), but colours will not vary in this grouping

addLegend

Should legends be added?

addGrid

should grids be added?

addLoess

should a loess smoother line be added?

titles

Plot title

logX

Should the x-axis be logged?

logY

similar to logX for y axis

idLines

Should reference lines of slope 1 and y-intercept 0 be added?

abLines

A list of reference lines. Each element should be a length 1 or 2 numeric vector. If length 1, a horizontal reference line will be added at that point, otherwise the intercept and slope of the line. If parameter does not satisfy these conditions, a warning will be emitted

xLab

x-axis label. By default, will use the names of the x-axis variable

yLab

similar to the above, but for y-axis label

types

Plot type to use. Allowed types are "p" (for standard points), "l" (lines connected by the variable specified in "iVars", "i" for points labelled by "iVars"), "o" (lines and points), and "t" for labels connected by lines grouped by "iVars"

overlaid

Logical flag. If TRUE, for each fixed x, the y variables will be overlaid onto a single plot

layout

A length 2 vector which is passed to the layout argument of xyplot

maxPanels

Maximum number of panels that should appear on each page of a graph.

maxTLevels

If a single numeric (or string), the maximum number of levels that a "by" variable can have before it is binned. If a character vector or a vector of length greater than one, the explicit breakpoints.

xRotAngle

Angle by which to rotate the x-axis tick marks

equalAxisScales

single logical

problemNum

Number of the problem (applicable to NMRun class only)

subProblems

Number of the simulation subproblems to use (applicable to the NMSim* classes only)

uniqueX

Number of unique values for the X axis. If number of uniques is less than or equal to this, a boxplot is created instead

graphParams

A full list of graphical parameter settings, such as that returned by getAllGraphParams. Will override global settings. By default, these will be the global settings

xAxisScaleRelations

X-axis scale relations when panels are displayed. One of "same", "free" or "sliced".

yAxisScaleRelations

Y-axis scale relations when panels are displayed. One of "same", "free" or "sliced".

...

Additional variables passed to the xyplot function

Format

An object of class numeric of length 1.

Value

An object of class multiTrellis holding the plot

Author(s)

Mango Solutions

Examples

1
2
3
4
5
6
7
8
## Not run:  
 Theoph.df <- as.data.frame(Theoph)
 nmScatterPlot(Theoph.df, xVar = "Time", yVar = "conc", 
   iVar = "Subject", type = "l", title = "Theophiline", yLab = "conc")
 Indometh.df <- as.data.frame(Indometh)
 nmScatterPlot(Indometh.df, xVar = "time", yVar = "conc", bVar = "Subject")

## End(Not run)

MangoTheCat/RNMGraphics documentation built on May 8, 2019, 3:51 p.m.