plot.burningEmbers: plot.burningEmbers

In rkrug/burningEmbers: Package for creating and plotting burningEmbers type graphs

Description

The plot method for the burningEmbers objects

Usage

## S3 method for class 'burningEmbers'
plot(
     x,
     ylim,
     labels,
     ny = 1000,
     relSpace = 7,
     add0line = TRUE,
     col = rev(heat.colors(1000)),
     borderB = "black",
     lwdB = 3,
     xlab = "",
     ylab = "",
     ...)

Arguments

x	burningEmbers object to be plotted
ylim	see plot
labels	labels for the bars. If not specified, will be taken from the row names of the x$colRange parameter
ny	default 1000; number of y blocks - 1000 should be sufficient
relSpace	relative width of the gap between bars compared to width to bars
add0line	default TRUE; if a line at y = 0 should be drawn
col	default rev(heat.colors(1000)); the colour to be used for the graph. The more values, the more continuous the gradient. 1000 should be fine.
borderB	default "black"; the colour of the borders arounf=d the bars
lwdB	default 3; the width of the borders arount=fd =he bars
xlab	x label
ylab	y label
...	additional parameter for the image() function. Examples are main, ...

Details

Plot a Burning Amber Diagram

Value

the data structur which was plotted

Author(s)

Rainer M. Krug

Examples

x <- burningEmbers()
plot(x)

x <- burningEmbers(
                   bot = c(1, -2, 3, -3),
                   top = c(2,  5, 4, -2)
                   )
plot(x, main = "This is a header")
plot(x, main = "This is a header", ylim = c(-1, 3))

rkrug/burningEmbers documentation built on July 5, 2019, 8:24 p.m.