summary.corr_matrix: S3 Summary for Dense Correlation Results

View source: R/corr_result_s3.R

summary.corr_matrixR Documentation

S3 Summary for Dense Correlation Results

Description

Representation-first summary for dense correlation outputs.

Usage

## S3 method for class 'corr_matrix'
summary(object, topn = NULL, show_ci = NULL, ...)

Arguments

object

A dense correlation result (corr_matrix).

topn

Optional number of head/tail rows when preview is truncated.

show_ci

One of "yes" or "no".

...

Unused.

Value

A standardized summary data frame with class c("summary.corr_result", "data.frame") (plus compatibility classes).


matrixCorr documentation built on April 18, 2026, 5:06 p.m.