rece: Build and optionally plot a radiocarbon-dated event count...

In wccarleton/chronup: Chronological Uncertainty Propagation Toolkit

Build and optionally plot a radiocarbon-dated event count ensemble (RECE).

Description

Build and optionally plot a radiocarbon-dated event count ensemble (RECE).

Usage

rece(
  c14_dates,
  nsamples,
  breaks,
  verbose = TRUE,
  BP = TRUE,
  cal_resolution = -1,
  plot_it = TRUE,
  time_axis_index = 100
)

Arguments

c14_dates	A matrix with two columns. The first column should contain mean uncalibrated radiocarbon dates and the second should contain the associated errors.
nsamples	Integer number of sampled sequences to plot.
breaks	Vector of temporal breakpoints to use for sampling. This is the analytical/plot resolution, not the calibration resolution. It also defines the temporal boundaries of the RECE.
verbose	Logical. The plot takes longer to create for more dates/samples. So, this logical parameter indicates whether the user wants to see messages indicating progress.
BP	Logical. Use Before Present (BP) timescale?
cal_resolution	Desired temporal resolution for calibration in years.
time_axis_index	Integer value determining which elements of breaks vector will be included in the x-axis ticks and labels for the optional plot. The axis ticks will refer to time bin midpoints and be drawn and labelled at seq(1, length(breaks) - 1, time_axis_label_index).

Value

Invisibly returns a list with three elements. The first is an radiocarbon-dated event count ensemble, which is a matrix containing probable count sequences where each column contains one probable sequence. The second element is matrix containing frequencies of counts in each time bin defined by breaks (used in the RECE heat map plot). The last element is the breaks argument for convenience—it can be used to provide timestamps for the first two returned objects (corresponds to the rows in each case).

wccarleton/chronup documentation built on March 29, 2023, 1:24 a.m.