ciplot.corregp: Plotting Confidence Intervals for Correspondence Regression

Description

Method to plot confidence intervals for coordinates in correspondence regression.

Usage

# S3 method for corregp
ciplot(x, parm = "x", axis, cl = 0.95, nq = TRUE,
  horiz = FALSE, na.rm = FALSE, type = "p", col = "darkgrey",
  cex = par("cex"), font = par("font"), family = par("family"),
  alim = NULL, adir = 1, ecol = "darkgrey", ewid = par("lwd"),
  etyp = par("lty"), psym = 16, pcol = par("col"), pcex = cex,
  pbgc = par("bg"), lwd = ewid, lty = etyp, sfrac = 0.01, gap = 0,
  main = NULL, sub = NULL, ...)
ciplot(x, ...)

Arguments

The output of a call to corregp (i.e. an object of class "corregp").

parm

The parameter for which to plot the confidence intervals. Can be either "y", "x", or any vector of term names in X, level names in X or level names in Y. Defaults to "x".

axis

The axis for which to plot the confidence intervals.

The confidence level for the confidence intervals. Defaults to 0.95.

Logical specifying whether to use a normal quantile (i.e. apply qnorm) in the computation of the confidence intervals. Defaults to TRUE. If FALSE, then the confidence intervals are computed directly with the quantile function.

horiz

Logical specifying whether the confidence intervals should be plotted horizontally or not. Defaults to FALSE.

na.rm

Logical specifying whether to omit NA coordinates from the plot. Defaults to FALSE.

type

The type of plot: see plot.default. For correspondence regression, there is an additional option "labs" which plots the text labels at the centers of the confidence intervals. Defaults to "p".

col

Color of the text labels: either numeric or see colors.

cex

Character expansion factor: a number to specify the size of the text labels.

font

Font of the text labels: 1 for plain, 2 for bold, 3 for italic, and 4 for bold italic. Defaults to 1.

family

Font family of the text labels: can be "serif", "sans", "mono" or one of the Hershey fonts.

alim

Vector of two values specifying the lower and upper limit between which to plot the axis.

adir

Reading direction of the text labels on the (horizontal) axis: either a numeric value between 0 and 3 (see the las argument in the graphical parameters par) or a character value matching either "horizontal" or "vertical". Defaults to 1 (horizontal).

ecol

Color of the error bars: either numeric or see colors.

ewid

Width of the error bars: a number to specify the line width.

etyp

Line type of the error bars: 0 or "blank", 1 or "solid", 2 or "dashed", 3 or "dotted", 4 or "dotdash", 5 or "longdash", 6 or "twodash". Defaults to 1.

psym

The symbol (or "plotting character") to use for the centers of the confidence intervals.

pcol

Color of the center symbol: either numeric or see colors.

pcex

Character expansion factor of the center symbol.

pbgc

Background color of the center symbol: either numeric or see colors.

lwd

Width of all lines except for the error bars, e.g. the connecting lines: a number to specify the line width.

lty

Line type of all lines except for the error bars, e.g. the connecting lines: 0 or "blank", 1 or "solid", 2 or "dashed", 3 or "dotted", 4 or "dotdash", 5 or "longdash", 6 or "twodash". Defaults to 1.

sfrac

Width of "crossbar" at the end of error bar as a fraction of the x plotting region. Defaults to 0.01.

gap

Space left between the center of the error bar and the lines marking the error bar in units of the height (width) of the letter "O". Defaults to 0.

main

The main title of the plot.

sub

The subtitle of the plot.

...

Further arguments passed to or from other methods.

Value

A plot window containing the confidence intervals.

Details

ciplot (of a corregp output) makes use of plotCI from the package gplots.

Examples

Run this code

# NOT RUN {
data(HairEye)
haireye.crg <- corregp(Eye ~ Hair * Sex, data = HairEye, b = 3000)
ciplot(haireye.crg, parm = "y", axis = 1)
ciplot(haireye.crg, parm = c("Hair", "Sex"), axis = 1)
# }