Plot Method for Categorical-Categorical Desc Objects

Visualises a (two-dimensional) cross-tabulation, as computed by DescToolsX::desc() for a categorical/categorical pair. Four panel types are available, selectable (and combinable) via which. Higher-dimensional tables (more than two margins) are not supported; a message is issued and the call returns invisibly.

Usage

# S3 method for class 'Desc.table'
plot(
  x,
  main = NULL,
  ylab = NULL,
  which = 1,
  verbose = NULL,
  col = .useTheme,
  box = .useTheme,
  stamp = .useTheme,
  ...
)

Arguments

x

an object of class "Desc.table", as returned by DescToolsX::desc() for a categorical-categorical pair.

main

main title. NULL (default) derives a title per panel from x$meta$xname (the deparsed expression originally passed to desc(), e.g. "table(Pizza$area, Pizza$driver)") combined with a panel-type label for context when multiple panels are shown (e.g. "table(Pizza$area, Pizza$driver) (Spineplot)"). There is no y ~ x pair to draw on here - x$meta carries only a single xname, since a table built outside a two-sided formula has no separately named "x" and "y" variable. "", NA, or FALSE suppress the title and compact the top margin. Any other string is used as-is, identically for every selected panel.

ylab

y-axis label. NULL (default) leaves the panel's own default in place (typically empty/unlabeled, since the row dimension of a table built via e.g. table(a, b) usually has no name carried in x$meta). Supplying a value overrides this for every selected panel.

which

integer vector selecting one or more panels to draw, in the given order. One or more of:

1: Spineplot (graphics::spineplot()). Default.
2: Mosaic plot (via plotMosaic()).
3: Mosaic plot (swapped axis).
4: Association plot (Cohen-Friendly plot) via plotAssoc().
5: Heatmap of cell proportions (via plotHeatmap(), scale = "prop").

Selecting multiple panels does not change the plotting layout (no implicit mfrow) - as with other plot.Desc.* methods, arranging multiple panels on one device is left to the caller (e.g. par(mfrow = c(2, 1)) beforehand).

verbose

integer; currently computed from x$meta$verbose/getOption("DescTools.verbose") for consistency with other plot.Desc.* methods, but not yet consulted to pick a default which.

col

color specification. .useTheme (default) resolves a panel-appropriate default rather than one shared color, since fill ramps, diverging palettes, and sequential heat scales are different things:

panel 1: a grey ramp from "grey30" to "grey90", sized to the number of rows of tab - the panel draws spineplot(t(tab)), so the stacked (filled) dimension is the row dimension of tab, not its columns (not theme-driven by design, to keep the unordered category fill neutral).
panel 2: a grey ramp from "grey30" to "grey90", sized to the number of columns of tab (the fill dimension of the untransposed mosaic), passed to plotMosaic().
panel 3: a grey ramp from "grey30" to "grey90", sized to the number of rows of tab - with swap = TRUE the fill dimension is the row dimension, passed to plotMosaic().
panel 4: left at plotAssoc()'s own default (pal("red-white-blue-3", n = 100)), a diverging palette - cell colors there encode the sign and strength of Pearson residuals, so a categorical or grey-ramp default would not be meaningful. Supplying col overrides this with the diverging palette of the user's choice.
panel 5: left at plotHeatmap()'s own default (pal("Blues", n = 100)), a sequential ramp - cell colors there encode magnitude only. Supplying col overrides this.

Supplying col explicitly overrides the default uniformly for every selected panel.

box

controls the plot frame. .useTheme (default) follows the active theme (getTheme()$box); FALSE/NA suppress it; a named list overrides frame-drawing arguments.

panel 1: has no effect - spineplot() always draws its native frame unconditionally, with no toggle to override it.
panels 2/3: plotMosaic() always draws its own frame; this argument has no effect.
panel 4: plotAssoc() has no frame/box concept of its own (it draws dashed reference lines instead); this argument has no effect.
panel 5: forwarded as-is to plotHeatmap()'s own box argument, which draws the outer frame via rect() at the exact tile boundaries rather than graphics::box().

stamp

controls the corner stamp. .useTheme (default) resolves to getTheme()$stamp, drawn once after all selected panels. Panels 2-5 delegate to plotMosaic()/ plotAssoc()/plotHeatmap(), whose own stamp argument is set to NA internally to avoid a duplicate. TRUE/FALSE/NULL, a string, or a named list for stamp().

...

further graphical parameters, passed to par() via the internal framework and to the underlying panel-drawing functions (spineplot(), plotMosaic(), plotAssoc(), or plotHeatmap(), depending on the selected panel).

Value

Invisibly returns x.

Details

The left margin is sized automatically from the longest of: the y-axis label, and - for panels 1/2 - the row names of tab drawn as axis tick labels, so neither is ever clipped regardless of which.

Only two-dimensional tables are supported. If x carries a table with more than two margins, a message is issued and the function returns invisibly without drawing anything.

Plot Method for Categorical-Categorical `Desc` Objects

Usage

Arguments

Value

Details

See also