point.estimates: Calculate a point estimate

View source: R/calibrate.R

point.estimatesR Documentation

Calculate a point estimate

Description

Calculate a point estimate of a calibrated distribution - either the weighted mean, the median or the mode (maximum). Note that point estimates often tend to be very poor representations of entire calibrated distributions, so please be careful and do not reduce entire calibrated distributions to just 1 point value.

Usage

point.estimates(
  calib,
  wmean = TRUE,
  median = TRUE,
  mode = TRUE,
  midpoint = TRUE,
  prob = 0.95,
  rounded = 1
)

Arguments

calib

The calibrated distribution, as returned from caldist()

wmean

Report the weighted mean (defaults to TRUE)

median

Report the median (defaults to TRUE)

mode

Report the mode, which is the year with the maximum probability (defaults to TRUE)

midpoint

Report the midpoint of the hpd range(s)

prob

probability range for the hpd range(s)

rounded

Rounding for reported probabilities. Defaults to 1 decimal.

Value

The chosen point estimates

Examples

point.estimates(caldist(130,20))
plot(tmp <- caldist(2450,50), type='l')
abline(v=point.estimates(tmp), col=1:4)

Maarten14C/IntCal documentation built on Oct. 11, 2023, 1:25 a.m.