rcarbon: plot.compositeKDE – R documentation

Pricing

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

Get Started for Free

Documentation

rcarbon

plot.compositeKDE

Plots a Composite Kernel Density Estimate of sampled radiocarbon dates.

Description

Plots a Composite Kernel Density Estimate of sampled radiocarbon dates.

Usage

## S3 method for class 'compositeKDE'
plot(
  x,
  calendar = "BP",
  type = "envelope",
  ylim = NA,
  xlim = NA,
  fill.col = "lightgrey",
  interval = 0.95,
  line.col = "black",
  line.type = 2,
  multiline.alpha = NA,
  multiline.col = "black",
  ...
)

Arguments

`x`	A `compositeKDE` class object generated using the `ckde` function.
`calendar`	Either `'BP'` or `'BCAD'`. Indicate whether the calibrated date should be displayed in BP or BC/AD. Default is `'BP'`.
`type`	Either `envelope` or `multiline`. Default is `envelope`.
`ylim`	the y limits of the plot.
`xlim`	the x limits of the plot. In BP or in BC/AD depending on the choice of the parameter `calender`. Notice that if BC/AD is selected BC ages should have a minus sign (e.g. `c(-5000,200)` for 5000 BC to 200 AD).
`fill.col`	Envelope color when `type='envelope'`. Default is 'lightgrey'.
`interval`	Quantile interval for the envelope. Default is 0.95.
`line.col`	Line color when `type='envelope'`. Default is 'black.
`line.type`	Line type when `type='envelope'`. Default is 2.
`multiline.alpha`	Alpha level for line transparency when `type='multiline'`. Default is 10/`nsim`, where `nsim` is the number of simulations. If `nsim` is smaller than 10, `multiline.alpha` will be set to 1.
`multiline.col`	Line color when `type='multiline'`. Default is 'black'.
`...`	Additional arguments affecting the plot

Details

Visualise a compositeKDE class object. If type is set 'envelope' an envelope of the percentile interval defined by the parameter interval is shown along with the mean KDE. If type is set 'multiline' all KDEs are shown.