summary.corr_edge_list: S3 Summary for Edge-List Correlation Results

View source: R/corr_result_s3.R

summary.corr_edge_listR Documentation

S3 Summary for Edge-List Correlation Results

Description

Representation-first summary for edge-list outputs.

Usage

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

Arguments

object

An edge-list correlation result.

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.