stripless (version 1.0-3)

displayStruc: Construct text For strucplot legends.

Description

Construct character strings for print and legend functions to display on the console or lattice plot.

Usage

displayStruc(struc, heading = c("Horizontal", "Vertical"), miss = "No Conditioning", abbrevLength = c(0, 0), ...)

Arguments

struc

The "structure" attribute of a strucplot object

heading

A character vector of length 2 giving the headings for the horizontal and vertical conditioning variables portions of the legend. Default = c("Horizontal", "Vertical").

miss

A character string to use when there is no conditioning either horizontally or vertically. Default = "No Conditioning"

abbrevLength

Default = c(0,0). Either a length 2 vector or a named list to control lengths of factor names and levels in the legend. If a length 2 vector, it gives the minlength argument for the abbreviate function for abbreviating all the factor names and their levels, in that order. A value of 0 for either means "don't abbreviate." For back compatibility, a single numeric y will also be accepted and changed to c(y,0). If a named list, the names must be those of of the conditioning factors to abbreviate, and values length 2 vectors as above to control abbreviation lengths for the corresponding factor names and levels.

...

Additional arguments, presently ignored

Value

A character vector of length 2 giving character strings, including \n line breaks.

Details

This is an exported auxiliary function that constructs the character strings for displaying plot structure on the console and possibly also in a legend on the lattice display. While not intended to be directly called by the user, it is exported for use by those who wish to supply custom legends for the lattice display.

Examples

require(datasets)
# quakes data
#
# Create and save plot
 out <- strucplot(lat ~ long|cut(mag,5)*cut(depth,4), data = quakes,
  col="blue", main = "Earthquake locations, by magnitude and depth")

 displayStruc(attr(out,"structure"))