xRing (version 0.1.1)

getBorders: Get Tree-Ring Borders

Description

Identify tree-ring borders

Usage

getBorders(x, k = 3, minTrw = 3, threshold = 0.215, addLastBorder = FALSE)

Arguments

x

an object of class "xRing"

k

integer; width of the rolling window

minTrw

integer; width of the narrowest tree-ring, rings narrower than this value will not be considered

threshold

the minimum difference between the local maximum and minimum density to detect tree-ring borders

addLastBorder

logical; if FALSE the last border is not added. If TRUE the last border is placed at the position of the last value.

Value

The getBorders function returns an object of lass "xRing" including the following elements:

names a string giving the series name

span the first and last year

trw a data.frame with tree-ring width

limits a vector with the position of the tree-ring borders

years a vector with the calendar year

profile.raw a vector with the raw X-ray values

profile a vector with the the smoothed X-ray values (if is supplied in the input)

Details

This function uses local maximum and minimum densities in order to detect tree-ring borders.

Examples

# NOT RUN {
data("PaPiRaw")
data("PaPiSpan")
AFO1001a <- toxRing(PaPiRaw, PaPiSpan, "AFO1001a")
AFO1001a <- getBorders(AFO1001a)

AFO1001a <- toxRing(PaPiRaw, seriesName = "AFO1001a")
AFO1001a <- getBorders(AFO1001a)

# }