linesTile: Add a connected line segment 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 simple line graphic for inclusion in a tile plot. For more advanced features suitable for summarizing inference from a model, use instead lineplot.

Usage

linesTile(...)

Arguments

...	Any number of arguments given below. Must include 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 linesTile(x=myxvar, y=myyvar), not linesTile(myxvar,myyvar)

Details

This function does no plotting; instead, it creates a linesTile 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.

linesTile simply creates a line or series of connected line segments to add to a tile plot. It serves as the tile equivalent to the base graphics lines or grid graphics linesGrob, and is primarily useful for annotating plots which also use other traces. If you need to draw a large number of disconnected line segments, creating a single trace made by polylinesTile will be much faster than creating a large number of linesTile traces.

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

Value

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

linesTile-specific parameters

A call to linesTile 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 linesTile-specific parameters, users may provide any of the generic tile parameters documented in pointsTile.

Author(s)

Christopher Adolph [e-mail]

See Also

tile, polylinesTile, lineplot

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