plot_box {aspace}R Documentation

Plot the Standard Distance Box

Description

This function plots the standard deviation of x- and y-coordinates as a box, with the edges set, respectively, to the standard deviation of the x- and y-coordinates.

Usage

plot_box(datin=NULL, plotnew=TRUE, plothv=FALSE, plotweightedpts=FALSE,
weightedpts.col='black', weightedpts.pch=19, plotpoints=TRUE, 
points.col='black', points.pch=1, plotcentre=TRUE, centre.col='black', 
centre.pch=19, titletxt="Title", xaxis="Easting (m)", 
yaxis="Northing (m)", box.col='black', box.lwd=2, jpeg=FALSE, ...)

Arguments

datin

Input data object; the result from calc_box()

plotnew

Boolean: Set to TRUE to create a new plot. Set to FALSE to overlay current plot.

plothv

Boolean: Set to TRUE if the orthogonal N-S, E-W axes are to be plotted through the centre

plotweightedpts

Boolean: Set to TRUE if the weighted point observations are to be plotted

weightedpts.col

Specify a colour for the weighted point observations

weightedpts.pch

Specify a plotting symbol for the weighted point observations

plotpoints

Boolean: Set to TRUE if the point observations are to be plotted

points.col

Specify a colour for the point observations

points.pch

Specify a plotting symbol for the point observations

plotcentre

Boolean: Set to TRUE if the mean/weighted/user-defined centre is to be plotted

centre.col

Specify a colour for the centre

centre.pch

Specify a plotting symbol for the centre

titletxt

A string to indicate the title for the plot

xaxis

A string to label the x-axis of the plot

yaxis

A string to label the y-axis of the plot

box.col

Specify a line colour for the SD Box

box.lwd

Specify a line width for the SD Box

jpeg

Boolean: Set to TRUE if the plot should be saved in JPEG format

...

Arguments to be passed to graphical parameters

Details

The element FORPLOTTING contained within the calc_box() output object is required to plot an SD Box. Provide the whole plot_box() output object as the argment for datin.

Value

This function returns a plot in the graphics device.

Author(s)

Tarmo K. Remmel, Randy Bui, Ron N. Buliung

See Also

plot_sdd, plot_sde

Examples

# NEED TO RUN THE BOX GENERATOR FIRST AND PASS THAT TO THE NEXT LINE
a <- calc_box(id=1, points=activities)
plot_box(datin=a, plotnew=TRUE, plothv=FALSE, plotweightedpts=FALSE,
plotpoints=TRUE, plotcentre=TRUE, titletxt="Title", 
xaxis="Easting (m)", yaxis="Northing (m)")

# plot_box() BY DEFAULT, TAKES AS INPUT THE RESULT PRODUCED BY calc_box()

[Package aspace version 4.1.0 Index]