summary.climate_histories: Summarises the output created by 'climate_histories'

In Bclim: Bayesian Palaeoclimate Reconstruction from Pollen Data

Description

Produces estimated climate values for a chosen climate dimension for each of the values supplied to the time_grid argument to climate_histories. For examples why not see the wonderful Bclim vignette (available at https://cran.r-project.org/web/packages/Bclim/index.html) and the author's personal webpage (https://maths.ucd.ie/parnell)?

Usage

## S3 method for class 'climate_histories'
summary(object, dim = 1, probs = c(0.05, 0.95),
  ...)

Arguments

object	An object of class climate_histories produced by the function climate_histories
dim	The chosen climate dimension. This could be GDD5 (dim=1), MTCO (dim=2) or AET/PET (dim=3)
probs	The chosen values at which to compute time-wise quantiles. The default is a 90% interval, i.e. from 5% to 95%
...	Not used

Details

The output is a table of time-wise confidence/credibility intervals for the climate histories at each time point given on the time grid for the specified climate dimension. The results can be saved in an object if required.

Value

A data frame with the following columns:

• time_grid The provided time grid points

• quantiles The quantiles of the climate variable for the specified probabilities

Note that this object is reported silently so will be discarded unless the function is called with an object as in the vignette.

See Also

See climate_histories for creating objects suitable for this function

Bclim documentation built on May 2, 2019, 12:38 a.m.