plotExceed.array: plotExceed.array function

View source: R/lgcpMethods.R

plotExceed.arrayR Documentation

plotExceed.array function

Description

Function for plotting exceedance probabilities stored in array objects. Used in plotExceed.lgcpPredict.

Usage

## S3 method for class 'array'
plotExceed(
  obj,
  fun,
  lgcppredict = NULL,
  xvals = NULL,
  yvals = NULL,
  window = NULL,
  cases = NULL,
  nlevel = 64,
  ask = TRUE,
  mapunderlay = NULL,
  alpha = 1,
  sub = NULL,
  ...
)

Arguments

obj

an object

fun

the name of the function used to compute exceedances (character vector of length 1). Note that the named function must be in memory.

lgcppredict

an object of class lgcpPredict that can be used to supply an observation window and x and y coordinates

xvals

optional vector giving x coords of centroids of cells

yvals

optional vector giving y coords of centroids of cells

window

optional obervation window

cases

optional xy (n x 2) matrix of locations of cases to plot

nlevel

number of colour levels to use in plot, default is 64

ask

whether or not to ask for a new plot between plotting exceedances at different thresholds.

mapunderlay

optional underlay to plot underneath maps of exceedance probabilities. Use in conjunction with rainbow parameter 'alpha' (eg alpha=0.3) to set transparency of exceedance layer.

alpha

graphical parameter takign values in [0,1] controlling transparency of exceedance layer. Default is 1.

sub

optional subtitle for plot

...

additional arguments passed to image.plot

Value

generic function returning method plotExceed

See Also

plotExceed.lgcpPredict


lgcp documentation built on Oct. 3, 2023, 5:08 p.m.