summary.pc_matrix: Summarize Pattern Causality Matrix

View source: R/classes.R

summary.pc_matrixR Documentation

Summarize Pattern Causality Matrix

Description

Provides a summary of the pattern causality matrix object. This function calculates and displays descriptive statistics (mean, SD, min, max) for each causality matrix (positive, negative, dark).

Usage

## S3 method for class 'pc_matrix'
summary(object, ...)

Arguments

object

A pc_matrix object.

...

Additional arguments passed to the summary function.

Value

Invisibly returns the input object.

Examples

data(climate_indices)
dataset <- climate_indices[, -1]
pc_matrix_obj <- pcMatrix(dataset, E = 3, tau = 1, 
  metric = "euclidean", h = 1, weighted = TRUE, 
  verbose = FALSE)
summary(pc_matrix_obj)

patterncausality documentation built on April 3, 2025, 6:57 p.m.