reconPlot {analogue}R Documentation

Stratigraphic plots of palaeoenvironmental reconstructions

Description

Draws a palaeoenvironmental reconstruction of predicted environmental values for sub-fossil assemblages.

Usage


reconPlot(x, ...)

## Default S3 method:
reconPlot(x, ...)

## S3 method for class 'predict.mat':
reconPlot(x, depths, use.labels = FALSE,
          predictions = c("apparent", "bootstrap"),
          error.bars = FALSE, sample.specific = TRUE,
          rev.x = TRUE, type = "l", xlim, ylim,
          xlab = "", ylab = "", main = "", ...)

Arguments

x An R object. Currently only objects of classes "predict.mat" and "mat" are supported.
depths numeric; a vector of depths for which predicted values exist or will be generated. Can be missing, in which case, if use.labels = TRUE, the function will attempt to derive suitable values for you. See Details below.
use.labels logical; should reconPlot attempt to derive values for argument depths from the names of the predicted values? Only use if depths is missing. See Details below.
predictions character; one of "apparent" or "bootstrap". Which type of predicted values should be plotted? The actual predictions ("apparent") or the bootstrap-derived predictions ("bootstrap").
error.bars logical; should error bars be drawn on the plot?
sample.specific logical; should sample specific errors be used? Only for predictions = "bootstrap".
rev.x logical; should the depth/age axis be reversed (drawn from high to low)?
type type of line drawn. See par and argument "type".
xlab, ylab character; the x- and y-axis labels respectively.
main character; main title for the plot.
xlim, ylim numeric, length 2; the x- and y-limits for the plotted axes. If not provided, the function will calculate appropriate values to cover the range of plotted values and any error bars (if requested via "error.bars".
... arguments passed to other graphics functions.

Details

Conventionally, these plots are drawn on a depth or an age scale. Argument depths is used to provide the depth or age axis, against which the predicted values are plotted.

If depths is not provided, then the function will try to derive the appropriate values from the labels of the predictions if use.labels = TRUE. You must provide depths or set use.labels = TRUE otherwise an error will result. The derived labels will be coerced to numerics. If your labels are coercible, then you'll either get nonsense on the plot or an error from R. If so, provide suitable values for depths.

Value

A plot on the currently active device.

Author(s)

Gavin L. Simpson

See Also

mat, and predict.mat

Examples

## continue the RLGH example from ?mat
example(mat)

## draw the reconstruction
reconPlot(rlgh.mat, use.labels = TRUE, error.bars = TRUE,
          xlab = "Depth", ylab = "pH")

[Package analogue version 0.3-3 Index]