This function generates a small report on a rwl 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.
rwl.report(rwl,small.thresh=NA,big.thresh=NA)A list with elements containing descriptive information on the rwl object. Specifically:
a numeric value passed in.
a numeric value passed in.
a numeric value with the number of series.
a numeric value with the total number of rings.
a numeric with the mean segment length.
a numeric with the first year.
a numeric with the last year.
a numeric with the mean AR1 value of all series.
a numeric with the standard deviation of the AR1 values of all series.
a logical indicating if there are rows (years) with all NA values.
a numeric vector with unconnected years.
a numeric with number of zeros in the data.
a list containing series and years with zeros or a numeric of 0.
a numeric indicating rows (years) with all zero values.
a list containing series and years with consecutive zeros or a numeric of 0.
a numeric with the mean interseries correlation.
a numeric with the standard deviation of the interseries correlations.
a list containing series and years with internal NA values or a numeric of 0.
a list of details taken from the record attached by read.tucson, or absent when the object carries no such record.
a list containing series and years with small rings or a numeric of 0.
a list containing series and years with large rings or a numeric of 0.
an rwl object of ring widths, such as produced by
read.rwl. An rwi object of indices is
reported on with a warning, since the report's means, zeros and
thresholds are about widths. Anything else is an error.
a numeric value for the threshold value that will cause
small rings to be listed. If values is NA this will be omitted.
a numeric value for the threshold value that will cause
large rings to be listed. If values is NA this will be omitted.
Andy Bunn. Patched and improved by Mikko Korpela.
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.
When the object still carries the record read.tucson attaches
to what it returns, the printed report opens with a short header naming the
file, the site and species from the ITRDB header, the precision the
file declares, and the span the header claims, which is worth seeing beside
the span the measurements actually cover. It also notes when the reader
renamed a series, so the ids in the report are not the file's, and when
interior gaps were filled. An object with no such record -- one built by
hand, read by read.tucson.legacy, or subsetted by column --
is reported exactly as before. Use rwl.check to have any of
this reported as findings rather than as context.
read.rwl, summary.rwl,
interseries.cor
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)
Run the code above in your browser using DataLab