Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!
Get Started for Free

rwl.report

Do some reporting on a RWL object


Description

This function generates a small report on a rwl (or rwi) object that gives the user some basic information on the data including the number of series, the span of the data, the mean interseries correlation, the number of missing rings (zeros), internal NA values, and rings that are very small, or very large.

Usage

rwl.report(rwl,small.thresh=NA,big.thresh=NA)

Arguments

rwl

a data.frame of ring widths with rownames(x) containing years and colnames(x) containing each series ID such as produced by read.rwl

small.thresh

a numeric value for the threshold value that will cause small rings to be listed. If values is NA this will be omitted.

big.thresh

a numeric value for the threshold value that will cause large rings to be listed. If values is NA this will be omitted.

Details

This report is a list containing the number of series, the mean length of all the series, the first year, last year, the mean first-order autocorrelation (via summary.rwl), the mean interseries correlation (via interseries.cor), the years where a series has a missing ring (zero), internal NA, very small ring, and very large rings.

This output of this function is not typically meant for the user to access but has a print method that formats that data for the user.

Value

A list with elements containing descriptive information on the rwl object.

Author(s)

Andy Bunn. Patched and improved by Mikko Korpela.

See Also

Examples

data("gp.rwl")
rwl.report(rwl = gp.rwl)
# list very small (smallest 1pct) of rings as well
one.pct <- quantile(gp.rwl[gp.rwl != 0], na.rm=TRUE, probs=0.01)
rwl.report(rwl = gp.rwl, small.thresh = one.pct)

dplR

Dendrochronology Program Library in R

v1.7.2
GPL (>= 2)
Authors
Andy Bunn [aut, cph, cre, trl], Mikko Korpela [aut, cph, trl], Franco Biondi [aut, cph], Filipe Campelo [aut, cph], Pierre Mérian [aut, cph], Fares Qeadan [aut, cph], Christian Zang [aut, cph], Allan Buras [ctb], Jacob Cecile [ctb], Manfred Mudelsee [ctb], Michael Schulz [ctb], Klesse Stefan [ctb], Frank David [ctb], Visser Ronald [ctb]
Initial release
2021-01-27

We don't support your browser anymore

Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.