Data Description

Usage

# S4 method for class 'CalibratedAges'
describe(x, calendar = getOption("ananke.calendar"), level = 0.954, ...)

Arguments

x: A CalibratedAges object.
calendar: An aion::TimeScale object specifying the target calendar (see aion::calendar()).
level: A length-one numeric vector giving the confidence level.
...: Further parameters to be passed to cat().

Value

describe() is called for its side-effects. Invisibly returns x.

References

Millard, A. R. (2014). Conventions for Reporting Radiocarbon Determinations. Radiocarbon, 56(2): 555-559. doi:10.2458/56.17455 .

Author

N. Frerebeau

Examples

## Calibrate multiple dates
cal <- c14_calibrate(
  values = c(5000, 4500),
  errors = c(45, 35),
  names = c("X", "Y")
)

## Full text description
describe(cal)
#> Sample X is dated to 5000 +/- 45 BP, calibrated to [-3944,-3855] (29.0%) or [-3844,-3833] (2.0%) or [-3818,-3653] (65.0%) CE (95.4% HPD interval) with intcal20 (Reimer et al. 2020).
#> 
#> Sample Y is dated to 4500 +/- 35 BP, calibrated to [-3355,-3091] (94.0%) or [-3050,-3040] (1.0%) CE (95.4% HPD interval) with intcal20 (Reimer et al. 2020).
#> 
#> Calibration was computed with R 4.4.1 (R Core Team 2024) and package ananke 0.0.1 (Frerebeau 2024).