Learn R Programming

rcarbon (version 1.5.1)

summary.CalDates: Summarise a CalDates class object

Description

Returns summary statistics of calibrated dates.

Usage

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

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.

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.