summary.mov_cor_dm: Summary method for running dendrometer-climate correlation...

View source: R/mov.cor.dm.R

summary.mov_cor_dmR Documentation

Summary method for running dendrometer-climate correlation objects

Description

Summarizes running dendrometer-climate correlations for both bootstrapped and non-bootstrapped outputs, and appends climate-specific settings to the summary tables.

Usage

## S3 method for class 'mov_cor_dm'
summary(object, absolute = TRUE, top_n = 5, ...)

Arguments

object

Object of class "mov_cor_dm".

absolute

Logical. If TRUE (default), the strongest correlation is identified by absolute magnitude.

top_n

Integer. Number of top windows to return per climate variable.

...

Unused.

Value

A list of class "summary_mov_cor_dm" containing:

  • table: summary table for each climate variable

  • top_windows: top running windows per climate variable

  • metadata: metadata from the original object

  • call: original function call


dendRoAnalyst documentation built on May 20, 2026, 5:07 p.m.