plot.spdppc: Plot SPD-based Posterior Predictive Check

View source: R/plot.spdppc.R

plot.spdppcR Documentation

Plot SPD-based Posterior Predictive Check

Description

Plots spdppc class object for SPD-based Posterior Predictive Check.

Usage

## S3 method for class 'spdppc'
plot(
  x,
  type = "envelope",
  nsample = NULL,
  interval = 0.9,
  obs.lwd = 1.5,
  obs.col = "black",
  sim.col = "lightgrey",
  alpha = 1,
  envelope.col = "lightgrey",
  positive.col = "red",
  negative.col = "blue",
  calendar = "BP",
  xlab = NULL,
  ylab = NULL,
  ...
)

Arguments

x

An spdppc class object.

type

Either a 'spaghetti' plot or a quantile based envelope plot. Default is 'envelope'.

nsample

Number of samples to be displayed in the 'spaghetti' plot. Default is the total number of simulations supplied in the 'spdppc' class object, ignored when type is set to 'envelope'.

interval

Quantile interval used for the envelope plot. Ignored when type is set to 'spaghetti'. Default is 0.90.

obs.lwd

Line width of the observed SPD. Default is 1.5.

obs.col

Line colour of the observed SPD. Default is 'black'.

sim.col

Line colour of simulated SPDs. Default is 'lightgrey', ignored when type is set to 'envelope'.

alpha

Transparency value for each line in the spaghetti plot. Default is 1, ignored when type is set to 'envelope'.

envelope.col

Fill colour of the simulation envelope. Default is 'lightgrey', ignored when type is set to 'envelope.'spaghetti'.

positive.col

Fill colour for the area with positive deviation from the simulation envelope. Default is 'red', ignored when type is set to 'spaghetti'.

negative.col

Fill colour for the area with positive deviation from the simulation envelope. Default is 'blue', ignored when type is set to 'spaghetti'.

calendar

Either 'BP' or 'BCAD'. Indicate whether the calibrated date should be displayed in BP or BC/AD. Default is 'BP'.

xlab

a label for the x axis. Default is 'Years cal BP','Years BC/AD','Years BC', or 'Years AD' depending on data range and settings of calendar.

ylab

a label for the y axis. Default is 'Probability'.

...

Additional arguments affecting the plot

Value

None.


nimbleCarbon documentation built on Aug. 14, 2023, 5:08 p.m.