ageranges: save age ranges of depth(s)
In rbacon: Age-Depth Modelling using Bayesian Statistics

ageranges

R Documentation

save age ranges of depth(s)

Description

Calculates an age summary (min/max probability range, median and mean) of a depth or a series of depths. The depths are returned and can be saved to a file.

Usage

ageranges(
  d = c(),
  file = c(),
  sep = "\t",
  set = get("info"),
  BCAD = set$BCAD,
  na.rm = FALSE,
  prob = 0.95,
  d.by = 1,
  roundby = 1,
  show.progress = TRUE
)

Arguments

`d`	Depth or depths for which age summaries are to be calculated. If left empty, a sequence of depths is calculated from the top to the bottom of the core, see 'd.by'.
`file`	The name of the file where the age summary has to be stored. If empty (default), the ages are returned.
`sep`	Separator for the fields, if saving to a file (defaults to a tab, "\t").
`set`	Detailed information of the current run, stored within this session's memory as variable `info`.
`BCAD`	The calendar scale of graphs and age output-files is in cal BP (calendar or calibrated years before the present, where the present is AD 1950) by default, but can be changed to BC/AD using `BCAD=TRUE`.
`na.rm`	Whether or not NAs are to be removed. Defaults to `na.rm=FALSE`. NAs will still be returned for depths outside of the core's depth range.
`prob`	Probability range. Half of the range is taken away from both sides of the distribution (e.g., 2.5% for the default of `prob=0.95`).
`d.by`	Steps for calculation of depths, if 'd' is left empty. Defaults to steps of 1.
`roundby`	Rounding for the age estimates. Defaults to 1 decimal.
`show.progress`	Show a progress bar. Defaults to TRUE.