nimbleCarbon (version 0.2.6)

modelPlot: Plot Growth Models

Description

Plots growth models based on user provided parameters for prior and posterior predictive checks.

Usage

modelPlot(
  model,
  a,
  b,
  params,
  type = c("spaghetti"),
  nsample = NULL,
  interval = 0.9,
  calendar = "BP",
  col = "lightgrey",
  alpha = 0.1,
  ylim = NULL,
  xlim = NULL,
  xlab = NULL,
  ylab = NULL,
  add = FALSE,
  lwd = 1,
  ...
)

Value

None.

Arguments

model

growth model.

a

lower (earliest) limit of the distribution (in BP).

b

upper (latest) limit of the distribution (in BP).

params

a list of vectors containing model parameters. The names attribute of each vector should match growth model parameters.

type

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

nsample

number of samples to be used. Default is the length of the parameter vectors supplied in the argument params.

interval

quantile interval used for the envelope plot. 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'.

col

fill color for the quantile envelope (when type=='envelope') or line colour (when type=='spaghetti').

alpha

transparency value for each line in the spaghetti plot or the fill color in the 'envelope' plot. Default is 1.

ylim

the y limits of the plot.

xlim

the x limits of the plot (in Cal 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'.

add

whether or not the new graphic should be added to an existing plot.

lwd

line width. Default is 1.

...

additional arguments affecting the plot

Examples

# \donttest{
params = list(k=runif(100,0.01,0.02),r=runif(100,0.003,0.004))
modelPlot(model=dLogisticGrowth,a=5000,b=2000,params=params,type=c('spaghetti'),alpha=0.5)
# }