hdr: Calculate highest density regions for Bchron calibrated ages

Description Usage Arguments Details Value See Also Examples

View source: R/hdr.R

Description

A function for computing highest density regions (HDRs)

Usage

1
hdr(date, prob = 0.95)

Arguments

date

A calibrated Bchron date, via e.g. BchronCalibrate

prob

The desired probability interval, in the range(0, 1)

Details

The output of this function is a list of contiguous ranges which cover the probability interval requested. A highest density region might have multiple such ranges if the calibrated date is multi-modal. These differ from credible intervals, which are always contiguous but will not be a good representation of a multi-modal probability distribution.

Value

A list where each element is one of the contiguous sets making up the HDR

See Also

BchronCalibrate

Examples

1
2
3
4
5
6
7
# Calibrate multiple ages and summarise them
ages <- BchronCalibrate(
  ages = 11553, ageSds = 230,
  calCurves = "intcal20"
)
# Get samples
hdr(ages$Date1)

Bchron documentation built on June 10, 2021, 9:10 a.m.