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.

1 | ```
rwl.report(rwl,small.thresh=NA,big.thresh=NA)
``` |

`rwl` |
a |

`small.thresh` |
a |

`big.thresh` |
a |

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.

A `list`

with elements containing descriptive information on the
`rwl`

object.

Andy Bunn. Patched and improved by Mikko Korpela.

`read.rwl`

, `summary.rwl`

,
`interseries.cor`

1 2 3 4 5 | ```
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)
``` |

Questions? Problems? Suggestions? Tweet to @rdrrHQ or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.