xpose.panel.bw: Default box-and-whisker panel function for Xpose 4

In andrewhooker/xpose4: Diagnostics for Nonlinear Mixed-Effect Models

Default box-and-whisker panel function for Xpose 4

Description

This is the box-and-whisker panel function for Xpose 4. This is not intended to be used outside the xpose.plot.bw function. Most of the arguments take their default values from xpose.data object but this can be overridden by supplying them as arguments to xpose.plot.bw.

Usage

xpose.panel.bw(
  x,
  y,
  object,
  subscripts,
  groups = NULL,
  inclZeroWRES = FALSE,
  onlyfirst = FALSE,
  samp = NULL,
  xvarnam = NULL,
  yvarnam = NULL,
  type = object@[e-mail]$type,
  col = object@[e-mail]$col,
  pch = object@[e-mail]$pch,
  cex = object@[e-mail]$cex,
  lty = object@[e-mail]$lty,
  fill = object@[e-mail]$col,
  ids = NULL,
  idsmode = object@[e-mail]$idsmode,
  idsext = object@[e-mail]$idsext,
  idscex = object@[e-mail]$idscex,
  idsdir = object@[e-mail]$idsdir,
  bwhoriz = object@[e-mail]$bwhoriz,
  bwratio = object@[e-mail]$bwratio,
  bwvarwid = object@[e-mail]$bwvarwid,
  bwdotpch = object@[e-mail]$bwdotpch,
  bwdotcol = object@[e-mail]$bwdotcol,
  bwdotcex = object@[e-mail]$bwdotcex,
  bwreccol = object@[e-mail]$bwreccol,
  bwrecfill = object@[e-mail]$bwrecfill,
  bwreclty = object@[e-mail]$bwreclty,
  bwreclwd = object@[e-mail]$bwreclwd,
  bwumbcol = object@[e-mail]$bwumbcol,
  bwumblty = object@[e-mail]$bwumblty,
  bwumblwd = object@[e-mail]$bwumblwd,
  bwoutcol = object@[e-mail]$bwoutcol,
  bwoutcex = object@[e-mail]$bwoutcex,
  bwoutpch = object@[e-mail]$bwoutpch,
  grid = object@[e-mail]$grid,
  logy = FALSE,
  logx = FALSE,
  force.x.continuous = TRUE,
  binvar = NULL,
  bins = 10,
  ...
)

Arguments

x	Name(s) of the x-variable.
y	Name(s) of the y-variable.
object	An xpose.data object.
subscripts	The standard Trellis subscripts argument (see xyplot).
groups	Name of the variable used for superpose plots.
inclZeroWRES	Logical value indicating whether rows with WRES=0 is included in the plot.
onlyfirst	Logical value indicating whether only the first row per individual is included in the plot.
samp	An integer between 1 and object@Nsim (seexpose.data-class) specifying which of the simulated data sets to extract from SData.
xvarnam	Character string with the name of the x-variable.
yvarnam	Character string with the name of the y-variable.
type	Character value indicating the type of display to use: "l"=lines, "p"=points, "b"=both points and lines.
col	Colour of lines and plot symbols.
pch	Plot character to use.
cex	Size of the plot characters.
lty	Line type.
fill	Fill colour.
ids	Character value with the name of the variable to label data points with.
idsmode	Determines the way text labels are added to plots. NULL means that only extreme points are labelled. Non-NULL means all data points are labelled. (See link{xpose.plot.default})
idsext	See link{xpose.plot.bw}
idscex	Size of text labels.
idsdir	A value of "both" (the default) means that both high and low extreme points are labelled while "up" and "down" labels the high and low extreme points respectively. See xpose.plot.bw
bwhoriz	logical value indicating whether box and whiskers should be horizontal or not. The default is FALSE.
bwratio	Ratio of box height to inter-box space. The default is 1.5. An argument for panel.bwplot.
bwvarwid	Logical. If TRUE, widths of boxplots are proportional to the number of points used in creating it. The default is FALSE. An argument for panel.bwplot.
bwdotpch	Graphical parameter controlling the dot plotting character 'bwdotpch="|"' is treated specially, by replacing the dot with a line. The default is 16. An argument for panel.bwplot.
bwdotcol	Graphical parameter controlling the dot colour - an integer or string. See 'col'. The default is black. An argument for panel.bwplot.
bwdotcex	The amount by which plotting text and symbols should be scaled relative to the default. 'NULL' and 'NA' are equivalent to '1.0'. An argument for panel.bwplot.
bwreccol	The colour to use for the box rectangle - an integer or string. The default is blue. See trellis.par.get and "box.rectangle".
bwrecfill	The colour to use for filling the box rectangle - an integer or string. The default is transparent (none). See trellis.par.get and "box.rectangle".
bwreclty	The line type for the box rectangle - an integer or string. The default is solid. See trellis.par.get and "box.rectangle".
bwreclwd	The width of the lines for the box rectangle - an integer. The default is 1. See trellis.par.get and "box.rectangle".
bwumbcol	The colour to use for the umbrellas - an integer or string. The default is blue. See trellis.par.get and "box.umbrella".
bwumblty	The line type for the umbrellas - an integer or string. The default is solid.See trellis.par.get and "box.umbrella".
bwumblwd	the width of the lines for the umbrellas - an integer. The default is 1. See trellis.par.get and "box.umbrella".
bwoutcol	The colour to use for the outliers - an integer or string. The default is blue. See trellis.par.get and "box.symbol".
bwoutcex	The amount by which outlier points should be scaled relative to the default. 'NULL' and 'NA' are equivalent to '1.0'. The default is 0.8. See trellis.par.get and "box.symbol".
bwoutpch	The plotting character, or symbol, to use for outlier points. Specified as an integer. See R help on 'points'. The default is an open circle. See trellis.par.get and "box.symbol".
grid	logical value indicating whether a visual reference grid should be added to the graph. (Could use arguments for line type, color etc).
logy	Logical value indicating whether the y-axis should be logarithmic.
logx	Logical value indicating whether the x-axis should be logarithmic.
force.x.continuous	Logical value indicating whether x-values should be taken as continuous, even if categorical.
binvar	Variable to be used for binning.
bins	The number of bins to be used. The default is 10.
...	Other arguments that may be needed in the function.

Author(s)

E. Niclas Jonsson, Mats Karlsson, Andrew Hooker & Justin Wilkins

See Also

xpose.data-class, Cross-references above.

andrewhooker/xpose4 documentation built on Feb. 26, 2024, 4:07 p.m.