detrend: Detrend Multiple Ring-Width Series Simultaneously

Description

This is a wrapper for detrend.series to detrend many ring-width series at once.

Usage

detrend(rwl, y.name = colnames(rwl), make.plot = FALSE,
  method=c("Spline","ModNegExp","Mean"), nyrs = NULL, f = NULL,
  pos.slope = FALSE)

Arguments

rwl

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

y.name

a character vector of length(ncol(rwl)) that gives the id of each series. Defaults to the column names of rwl.

make.plot

logical flag. Makes plots of the raw data and detrended data if TRUE. See details below.

method

a character vector to determine the detrending method. See details below. Possible values are Spline, ModNegExp, Mean, or subset of c(Spline, ModNegExp,

nyrs

a number giving the rigidity of the smoothing spline, defaults to 0.67 of series length if nyrs is NULL.

a number between 0 and 1 giving the frequency response or wavelength cutoff. Defaults to 0.5 if f is NULL.

pos.slope

a logical flag. Will allow for a positive slope to be used in method ModNegExp. If FALSE the line will be horizontal.

Value

If one detrending method is used, a data.frame containing the dimensionless detrended ring widths with column names, row names and dimensions of rwl. If more methods are used, a list with ncol(rwl) elements each containing a data.frame with the detrended ring widths in each column.

Details

See detrend.series for details on detrending methods. Setting make.plot = TRUE will cause plots of each series to be produced. These could be saved using Devices if desired.

Examples

Run this code

data(ca533)
  # Detrend using modified expontential decay. Returns a data.frame
  ca533.rwi <- detrend(rwl = ca533, method = "ModNegExp")
  # Detrend using both methods. Returns a list
  ca533.rwi <- detrend(rwl = ca533)

  # Save a pdf of all series
    pdf("foo.pdf")
      ca533.rwi <- detrend(rwl = ca533, method = c("Spline", "ModNegExp"),
        make.plot=T)
    dev.off()