series.rwl.plot: Plot Series and a Master

View source: R/series.rwl.plot.R

series.rwl.plotR Documentation

Plot Series and a Master

Description

Plots a tree-ring series with a master chronology and displays their fit, segments, and detrending options in support of the cross-dating functions.

Usage

series.rwl.plot(rwl, series, series.yrs = as.numeric(names(series)),
                seg.length = 100, bin.floor = 100, n = NULL,
                prewhiten = TRUE, biweight = TRUE, floor.plus1 = FALSE)

Arguments

rwl

a data.frame with series as columns and years as rows such as that produced by read.rwl.

series

a numeric or character vector. Usually a tree-ring series. If the length of the value is 1, the corresponding column of rwl is selected (by name or position) as the series and ignored when building the master chronology. Otherwise, the value must be numeric.

series.yrs

a numeric vector giving the years of series. Defaults to as.numeric(names(series)). Ignored if series is an index to a column of rwl.

seg.length

an even integral value giving length of segments in years (e.g., 20, 50, 100 years).

bin.floor

a non-negative integral value giving the base for locating the first segment (e.g., 1600, 1700, 1800 AD). Typically 0, 10, 50, 100, etc.

n

NULL or an integral value giving the filter length for the hanning filter used for removal of low frequency variation.

prewhiten

logical flag. If TRUE each series is whitened using ar.

biweight

logical flag. If TRUE then a robust mean is calculated using tbrm.

floor.plus1

logical flag. If TRUE, one year is added to the base location of the first segment (e.g., 1601, 1701, 1801 AD).

Details

The function is typically invoked to produce four plots showing the effect of the detrending options n and prewhiten and the binning options seg.length and bin.floor.

Plot 1

Time series plot of the filtered series and the master

Plot 2

Scatterplot of series vs. master

Plot 3

Segments that would be used in the other cross-dating functions (e.g., corr.series.seg)

Plot 4

Text giving the detrending options and the time span of the raw and filtered series and master

The series and master are returned as well.

See help pages for corr.rwl.seg, corr.series.seg, and ccf.series.rwl for more information on these arguments.

Value

A list containing the filtered vectors series and master.

Author(s)

Andy Bunn. Patched and improved by Mikko Korpela.

See Also

corr.rwl.seg, corr.series.seg, ccf.series.rwl

Examples

library(utils)
data(co021)
foo <- series.rwl.plot(rwl = co021, series = "646244", seg.length = 100,
                       n = 5)
## note effect of n on first year in the series
foo <- series.rwl.plot(rwl = co021, series = "646244", seg.length = 100,
                       n = 13, prewhiten = FALSE)
bar <- series.rwl.plot(rwl = co021, series = "646244", seg.length = 100,
                       n = 7, prewhiten = FALSE)
head(foo$series)
head(bar$series)

dplR documentation built on June 22, 2024, 9:59 a.m.