dplR (version 1.7.7)

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)

Value

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

small.thresh

a numeric value passed in.

big.thresh

a numeric value passed in.

nSeries

a numeric value with the number of series.

n

a numeric value with the total number of rings.

meanSegLength

a numeric with the mean segment length.

firstYear

a numeric with the first year.

lastYear

a numeric with the last year.

meanAR1

a numeric with the mean AR1 value of all series.

sdAR1

a numeric with the standard deviation of the AR1 values of all series.

unconnected

a logical indicating if there are rows (years) with all NA values.

unconnectedYrs

a numeric vector with unconnceted years.

nZeros

a numeric with number of zeros in the data.

zeros

a list containing series and years with zeros or a numeric of 0.

allZeroYears

a numeric indicating rows (years) with all zero values.

consecutiveZeros

a list containing series and years with consecuative zeros or a numeric of 0.

meanInterSeriesCor

a numeric with the mean interseries correlation.

sdInterSeriesCor

a numeric with the standard deviation of the interseries correlations.

internalNAs

a list containing series and years with internal NA values or a numeric of 0.

smallRings

a list containing series and years with small rings or a numeric of 0.

bigRings

a list containing series and years with small rings or a numeric of 0.

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.

Author

Andy Bunn. Patched and improved by Mikko Korpela.

Details

This generates information about a rwl object including 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, very large rings, etc.

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

See Also

read.rwl, summary.rwl, interseries.cor

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)