calibrate: Calibrate all valid dates in a *c14_date_list*

In ropensci/c14bazAAR: Download and Prepare C14 Dates from Different Source Databases

Calibrate all valid dates in a c14_date_list

Description

Calibrate all dates in a c14_date_list with Bchron::BchronCalibrate(). The function provides two different kinds of output variables that are added as new list columns to the input c14_date_list: calprobdistr and calrange. calrange is accompanied by sigma. See ?Bchron::BchronCalibrate and ?c14bazAAR:::hdr for some more information.
calprobdistr: The probability distribution of the individual date for all ages with an individual probability >= 1e-06. For each date there's a data.frame with the columns calage and density.
calrange: The contiguous ranges which cover the probability interval requested for the individual date. For each date there's a data.frame with the columns dens and from and to.

Usage

calibrate(
  x,
  choices = c("calrange"),
  sigma = 2,
  calCurves = rep("intcal20", nrow(x)),
  ...
)

## Default S3 method:
calibrate(
  x,
  choices = c("calrange"),
  sigma = 2,
  calCurves = rep("intcal20", nrow(x)),
  ...
)

## S3 method for class 'c14_date_list'
calibrate(
  x,
  choices = c("calrange"),
  sigma = 2,
  calCurves = rep("intcal20", nrow(x)),
  ...
)

Arguments

x	an object of class c14_date_list
choices	whether the result should include the full calibrated probability dataframe ('calprobdistr') or the sigma range ('calrange'). Both arguments may be given at the same time.
sigma	the desired sigma value (1,2,3) for the calibrated sigma ranges
calCurves	a vector of values containing either intcal20, shcal20, marine20, or normal (older calibration curves are supposed such as intcal13). Should be the same length the number of ages supplied. See BchronCalibrate for more information
...	passed to BchronCalibrate

Value

an object of class c14_date_list with the additional columns calprobdistr or calrange and sigma

Examples

calibrate(
  example_c14_date_list,
  choices = c("calprobdistr", "calrange"),
  sigma = 1
)

ropensci/c14bazAAR documentation built on June 3, 2024, 6:23 a.m.