summary.CalDates: Summarise a 'CalDates' class object

Description Usage Arguments Value

View source: R/calibration.R

Description

Returns summary statistics of calibrated dates.

Usage

1
2
## S3 method for class 'CalDates'
summary(object, prob = NA, calendar = "BP", ...)

Arguments

object

A CalDates class object.

prob

A vector containing probabilities for the higher posterior density interval. Default is c(0.683,0.954), i.e. 1 and 2-Sigma range.

calendar

Whether the summary statistics should be computed in cal BP ("BP") or in BCAD ("BCAD").

...

further arguments passed to or from other methods.

Value

A data.frame class object containing the ID of each date, along with the median date and one and two sigma (or a user specified probability) higher posterior density ranges.


rcarbon documentation built on Jan. 13, 2021, 7:09 p.m.