ananke (version 0.1.0)

describe: Data Description

Description

Data Description

Usage

# S4 method for CalibratedAges
describe(x, calendar = get_calendar(), level = 0.954, ...)

Value

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

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().

Author

N. Frerebeau

References

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

Examples

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

## Full text description
describe(cal)