textTile: Add plotted text labels to a tile plot

In chrisadolph/tileForShiny: Plot multiple graphical displays in a tiled layout with automated or customizable titles, axes, and annotations

Description

Initializes a trace which plots text to a tile graphic.

Usage

textTile(...)

Arguments

...	Any number of arguments given below. Must include the text labels, exactly one horizontal dimension (x or top), and exactly one vertical dimension (y or right). All inputs should be identified by appropriate tags; i.e., use textTile(x=myxvar, y=myyvar), not textTile(myxvar,myyvar)

Details

This function does no plotting; instead, it creates a textTile object, or trace of plotting data, to be drawn on one or more plots in a tiled arrangement of plots. To complete the drawing include the object as an input to tile. From tile, it is possible to set further options including plot and axis titles, axis ranges and labels, logged axes, and annotations to the plot.

textTile simply adds text at a specific location or locations to a tile plot. It serves as the tile equivalent to the base graphics text or grid graphics textGrob, and is primarily useful for annotating plots which also use other traces. Note that textTile traces must be created in advance and included in the call to tile, rather than added afterward.

To plot text to a location outside the plotting area, users might try combining clip="off", with coordinates placing the text in the desired spot.

Value

A textTile object, used only as an input to tile.

textTile-specific parameters

The primary input to textTile is the text itself:

labels

The text to plot; may be scalar or vector.

A call to textTile must provide an orthogonal pair of the following inputs:

x

coordinate vector of data to plot, attached to the x axis.

y

coordinate vector of data to plot, attached to the y axis.

top

coordinate vector of data to plot, attached to the top axis.

right

coordinate vector of data to plot, attached to the right axis.

Users will often wish to provide the following input:

plot

scalar or vector, the plot(s) in which this trace will be drawn; defaulting to the first plot. Plots are numbered consecutively from the top left, row-by-row. Thus in a 2 x 3 tiling, the first plot in the second row is plot number 4.

In addition to these textTile-specific parameters, users may provide any of the generic tile parameters documented in pointsTile.

Author(s)

Christopher Adolph [e-mail]

See Also

tile

chrisadolph/tileForShiny documentation built on Feb. 6, 2022, 12:34 a.m.