plotRects: Plot a set of rectangles

View source: R/plotRects.r

plotRectsR Documentation

Plot a set of rectangles

Description

This function can be used to plot a set of rectangles in a new plot, or to add them to an existing plot. It is basically the function rect, with some pre-defined settings.

Usage

plotRects(R, grid=FALSE, grid.lty=3, grid.col="lightgray", 
          density=NULL, angle=45, col=NA, border=rainbow(nrow(R)), 
          lty=1, lwd=1, add=FALSE, xlim=NULL, ylim=NULL, xlab="", 
          ylab="", main="", sub="")

Arguments

R

A nx4 matrix of rectangles. Each row corresponds to an rectangle, represented as (x1,x2,y1,y2). The point (x1,y1) is the lower left corner of the rectangle and the point (x2,y2) is the upper right corner of the rectangle.

grid

Logical, indicating if a grid should be drawn. The default value is FALSE.

grid.lty

Line type of the grid lines. The default value is 3=dotted.

grid.col

Line color of the grid lines. The default value is light gray.

density

Density of shading lines for the rectangles, in lines per inch. The default value is NULL, meaning that no shading lines are drawn. A zero value of density means no shading lines whereas negative values (and NA) suppress shading (and so allow color filling).

angle

Angle (in degrees) of the shading lines.

col

Color(s) to fill or shade the rectangles with. The default NA (or also NULL) means do not fill, i.e., draw transparent rectangles, unless density is specified.

border

Color for rectangle borders. Use border = NA to omit borders. If there are shading lines, border = TRUE means use the same color for the border as for the shading lines. The default value is rainbow(n): a vector of n contiguous colors from the palette rainbow.

lty

Line type for borders and shading of the rectangles. The default value is 1="solid".

lwd

Line width for borders and shading of the rectangles. The default value is 1.

add

Logical, indicating if the rectangles should be added to an existing plot. The default value is FALSE.

xlim

Range of the x-axis. The default value is the range of x-coordinates of the rectangles.

ylim

Range of the y-axis. The default value is the range of y-coordinates of the rectagnles.

xlab, ylab

Labels of the x and y axis. The default values are empty.

main

Title of the plot. The default value is empty.

sub

Sub title of the plot. The default value is empty.

Value

No value is returned.

Author(s)

Marloes Maathuis: maathuis@stat.math.ethz.ch

See Also

rect, palette

Examples

n <- 10
x <- c(0:(n-1))
R <- cbind(x,x+3,x,x+3)  # first rectangle is (0,3)x(0,3), 
                         # second rectangle is (1,4)x(1,4), etc...
par(mfrow=c(1,1))
plotRects(R,main="Example")

MLEcens documentation built on Oct. 18, 2022, 5:05 p.m.

Related to plotRects in MLEcens...