summary.pc_effect: Summarize Pattern Causality Effect

View source: R/classes.R

summary.pc_effectR Documentation

Summarize Pattern Causality Effect

Description

Provides a summary of the pattern causality effect analysis results. This function displays the summary statistics for the effects, including the number of components and the strongest effects.

Usage

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

Arguments

object

A pc_effect 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)
effects <- pcEffect(pc_matrix_obj)
summary(effects)


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