plot.CalDates: Plot calibrated dates

View source: R/plots.R

plot.CalDatesR Documentation

Plot calibrated dates

Description

Plot calibrated radiocarbon dates.

Usage

## S3 method for class 'CalDates'
plot(
  x,
  ind = 1,
  label = NA,
  calendar = "BP",
  type = "standard",
  xlab = NA,
  ylab = NA,
  axis4 = TRUE,
  HPD = FALSE,
  credMass = 0.95,
  customCalCurve = NA,
  add = FALSE,
  col = "grey50",
  col2 = "grey82",
  cex.axis = 0.75,
  cex.xylab = 0.75,
  cex.label = 0.75,
  ...
)

Arguments

x

CalDates class object containing calibrated radiocarbon dates.

ind

Number indicating the index value of the calibrated radiocarbon date to be displayed. Default is 1.

label

(optional) Character vector to be shown on the top-right corner of the display window.

calendar

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

type

Either 'standard' or 'auc'. If set to 'auc', displays both the normalised (dashed line) and unnormalised curves. Default is 'standard'.

xlab

(optional) Label for the x axis. If unspecified the default setting will be applied ("Year BP" or "Year BC/AD").

ylab

(optional) Label for the y axis. If unspecified the default setting will be applied ("Radiocarbon Age").

axis4

Logical value indicating whether an axis of probabilities values should be displayed. Default is TRUE.

HPD

Logical value indicating whether intervals of higher posterior density should be displayed. Default is FALSE.

credMass

A numerical value indicating the size of the higher posterior density interval. Default is 0.95.

customCalCurve

A three column data.frame or matrix that allows you to pass and plot a custom calibration curve if you used one during calibration. You can currently only provide one such custom curve which is used for all dates.

add

if set to TRUE the calibrated date is displayed over the existing plot. Default is FALSE.

col

The primary fill color for the calibrated date distribution.

col2

The secondary colour fill color for the calibrated date distribution, used for regions outside the higher posterior interval. Ignored when HPD=FALSE.

cex.axis

The magnification to be used for axis annotation relative to the current setting of cex. Default is adjusted to 0.75.

cex.xylab

The magnification to be used for x and y labels relative to the current setting of cex. Default is adjusted to 0.75.

cex.label

The magnification to be used for the label on the top right corner defined by the argument label. Default is adjusted to 0.75.

...

Additional arguments affecting the plot.

See Also

calibrate

Examples

x <- calibrate(x=c(3402,3490,4042),errors=c(20,20,30))
plot(x) #display the first date
plot(x,2) #displays the second date
plot(x,3, calendar="BCAD", HPD=TRUE) #display in BC/AD with higher posterior density interval

ahb108/rcarbon documentation built on Aug. 29, 2023, 9:21 a.m.