spatstat (version 1.31-3)

plot.listof: Plot a List of Things

Description

Plots a list of things

Usage

## S3 method for class 'listof':
plot(x, \dots, main, arrange=TRUE,
   nrows=NULL, ncols=NULL, main.panel=NULL, mar.panel=c(2,1,1,2),
   panel.begin=NULL, panel.end=NULL, panel.args=NULL, plotcommand="plot",
   adorn.left=NULL, adorn.right=NULL, adorn.top=NULL, adorn.bottom=NULL,
   adorn.size=0.2)

Arguments

x

An object of the class "listof". Essentially a list of objects.

...

Arguments passed to plot when generating each plot panel.

main

Overall heading for the plot.

arrange

Logical flag indicating whether to plot the objects side-by-side on a single page (arrange=TRUE) or plot them individually in a succession of frames (arrange=FALSE).

nrows,ncols

Optional. The number of rows/columns in the plot layout (assuming arrange=TRUE). You can specify either or both of these numbers.

main.panel

Optional. A character string, or a vector of character strings, giving the headings for each of the objects.

mar.panel

Value of the graphics parameter mar controlling the size of the margins outside each plot panel. See the help file for par.

panel.begin,panel.end

Optional. Functions that will be executed before and after each panel is plotted. See Details.

panel.args

Internal use only.

plotcommand

Optional. Character string containing the name of the command that should be executed to plot each panel.

adorn.left,adorn.right,adorn.top,adorn.bottom

Optional. Functions (with no arguments) that will be executed to generate additional plots at the margins (left, right, top and/or bottom, respectively) of the array of plots.

adorn.size

Relative width (as a fraction of the other panels' widths) of the margin plots.

Value

• Null.

Details

This is the plot method for the class "listof".

An object of class "listof" (defined in the base R package) represents a list of objects, all belonging to a common class. The base R package defines a method for printing these objects, print.listof, but does not define a method for plot. So here we have provided a method for plot.

In the spatstat package, the function density.splitppp produces an object of class "listof", essentially a list of pixel images. These images can be plotted in a nice arrangement using plot.listof. See the Example.

The arguments panel.begin and panel.end may be functions that will be executed before and after each panel is plotted. They will be called as panel.begin(i, y, main=main.panel[i]) and panel.end(i, y, add=TRUE).

Alternatively, panel.begin and panel.end may be objects of some class that can be plotted with the generic plot command. They will be plotted before and after each panel is plotted.

If all entries of x are pixel images, the function image.listof is called to control the plotting. The arguments equal.ribbon and col can be used to determine the colour map or maps applied.

See Also

print.listof, contour.listof, image.listof, density.splitppp

Examples

# Multitype point pattern
 data(amacrine)
 plot(D <- density(split(amacrine)))
 plot(D, main="", equal.ribbon=TRUE,
      panel.end=function(i,y,...){contour(y, ...)})