accrate.depth.summary: Provide a summary of the estimated accumulation rates for any...

View source: R/accrate.R

accrate.depth.summaryR Documentation

Provide a summary of the estimated accumulation rates for any depth of a core.

Description

Obtain a summary (95% range, 68% range, median, mean) of the accumulation rates (in years per cm, so actually sedimentation times) as estimated by the MCMC iterations for any depth of a core.

Usage

accrate.depth.summary(
  d,
  set = get("info"),
  cmyr = FALSE,
  na.rm = FALSE,
  probs = c(0.025, 0.16, 0.84, 0.975, 0.5)
)

Arguments

d

The depth for which accumulation rates need to be returned.

set

Detailed information of the current run, stored within this session's memory as variable info.

cmyr

Accumulation rates can be calculated in cm/year or year/cm. By default cmyr=FALSE and accumulation rates are calculated in year per cm.

na.rm

Remove NA entries. These are NOT removed by default, so that always the same amount of iterations is returned.

probs

The probability ranges to be returned. Defaults to the minima and maxima of the 95% and 68% ranges, as well as the median: probs=c(.025, .16, .84, .975, .5).

Value

A summary of the estimated accumulation rate of the chosen depth: minimum of the 95% interval, minimum of the 68% interval, maximum of the 68% interval, maximum of the 95% interval, median (i.e., 50%) and mean.

Author(s)

Maarten Blaauw

Examples

## Not run: 
  Bacon(run=FALSE, coredir=tempfile())
  agedepth(yr.res=50, d.res=50, d.by=10)
  accrate.depth.summary(20)

## End(Not run)

rbacon documentation built on Sept. 30, 2024, 9:40 a.m.