draw.dates: add calibrated distributions to a plot.

View source: R/plots.R

draw.datesR Documentation

add calibrated distributions to a plot.

Description

Add individual calibrated dates to a plot.

Usage

draw.dates(
  age,
  error,
  depth,
  cc = 1,
  postbomb = FALSE,
  reservoir = c(),
  calibt = c(),
  prob = 0.95,
  threshold = 0.001,
  BCAD = FALSE,
  ex = 0.9,
  normalise = TRUE,
  draw.hpd = TRUE,
  hpd.lwd = 2,
  hpd.col = rgb(0, 0, 1, 0.7),
  mirror = TRUE,
  up = FALSE,
  on.axis = 1,
  col = rgb(0, 0, 1, 0.3),
  border = rgb(0, 0, 1, 0.5),
  add = FALSE,
  cal.lab = c(),
  cal.lim = c(),
  y.lab = c(),
  y.lim = c(),
  y.rev = TRUE,
  labels = c(),
  label.x = 1,
  label.y = c(),
  label.cex = 0.8,
  label.col = border,
  label.offset = c(0, 0),
  label.adj = c(1, 0),
  label.rot = 0,
  ccdir = NULL,
  ...
)

Arguments

age

Mean of the uncalibrated C-14 age (or multiple ages).

error

Error of the uncalibrated C-14 age (or ages).

depth

Depth(s) of the date(s)

cc

Calibration curve for C-14 dates (1, 2, 3, or 4, or, e.g., "IntCal20", "Marine20", "SHCal20", "nh1", "sh3", or "mixed"). If there are multiple dates but all use the same calibration curve, one value can be provided.

postbomb

Whether or not this is a postbomb age. Defaults to FALSE.

reservoir

Reservoir age, or reservoir age and age offset.

calibt

Calibration based on the student-t distribution. By default, the Gaussian distribution is used (calibt=FALSE). To use the student-t distribution, provide two parameters such as calibt=c(3,4).

prob

Probability confidence intervals (between 0 and 1).

threshold

Report only values above a threshold. Defaults to threshold=0.001.

BCAD

Use BC/AD or cal BP scale (default cal BP).

ex

Exaggeration of the height of the distribution

normalise

If TRUE, the date is normalised by setting its peak value to 1 (handy for estimating how high to draw it). If there are multiple dates, it is normalised to the peak of the most precise date. Otherwise the peak of each date is at the same height.

draw.hpd

Whether or not to draw the hpd ranges as a line

hpd.lwd

Width of the line of the hpd ranges

hpd.col

Colour of the hpd rectangle

mirror

Plot distributions mirrored, a bit like a swan. Confuses some people but looks nice to the author so is the default.

up

If mirror is set to FALSE, the distribution can be plotted up or down, depending on the direction of the axis.

on.axis

Which axis to plot on. Defaults to 'x' or 1, but can be set to 'y' or 2.

col

Colour of the inside of the distribution

border

Colour of the border of the distribution

add

Whether or not to add the dates to an existing plot. If set to FALSE (default), a plot will be set up.

cal.lab

Title of the calendar axis (if present)

cal.lim

Limits of the calendar axis (if present)

y.lab

Title of the vertical axis (if present)

y.lim

Limits of the vertical axis (if present)

y.rev

Reverse the y-axis. Defaults to TRUE

labels

Add labels to the dates. Empty by default.

label.x

Horizontal position of the date labels. By default draws them before the youngest age (1), but can also draw them after the oldest age (2), or above its mean (3).

label.y

Vertical positions of the labels. Defaults to 0 (or 1 if label.x is 3 or 4).

label.cex

Size of labels.

label.col

Colour of the labels. Defaults to the colour given to the borders of the dates.

label.offset

Offsets of the positions of the labels, giving the x and y offsets. Defaults to c(0,0).

label.adj

Justification of the labels. Follows R's adj option: A value of ‘0’ produces left-justified text, ‘0.5’ (the default) centered text and ‘1’ right-justified text.

label.rot

Rotation of the label. 0 by default (horizontal).

ccdir

Directory of the calibration curves. Defaults to where the package's files are stored (system.file), but can be set to, e.g., ccdir="curves".

...

Additional plotting options

Examples

  plot(0, xlim=c(500,0), ylim=c(0, 2))
  draw.dates(130, 20, depth=1) 

IntCal documentation built on July 12, 2022, 1:05 a.m.