summary.tna_permutation: Summarize Permutation Test Results

View source: R/summary.R

summary.tna_permutationR Documentation

Summarize Permutation Test Results

Description

Returns the results of a permutation test as a tidy table, for the edges or for the centrality measures.

Usage

## S3 method for class 'tna_permutation'
summary(object, what = "edges", digits = 2L, ...)

## S3 method for class 'group_tna_permutation'
summary(object, what = "edges", digits = 2L, ...)

Arguments

object

A tna_permutation or a group_tna_permutation object.

what

A character string, the results to return: "edges" (the default) or "centralities". The centralities are available when the test was run with measures.

digits

An integer, the number of decimals of diff_true and effect_size. The p-values are not rounded. The default is 2.

...

Ignored.

Value

A data.frame with one row per edge, or per state and centrality measure, and per pair of groups (in the first column pair) for a group_tna_permutation object. For the edges, the columns are from, to, diff_true (the observed difference in the edge weight), effect_size (the difference divided by the standard deviation of the permuted differences, NA when they do not vary), and p_value. For the centralities, state and centrality replace from and to. An error of class tna_error_permutation is raised when what = "centralities" and the test was run without measures.

See Also

Validation functions bootstrap(), deprune(), estimate_cs(), markov_order(), permutation_test(), permutation_test.group_tna(), plot.group_tna_bootstrap(), plot.group_tna_permutation(), plot.group_tna_stability(), plot.tna_bootstrap(), plot.tna_markov_order(), plot.tna_permutation(), plot.tna_reliability(), plot.tna_stability(), print.group_tna_bootstrap(), print.group_tna_permutation(), print.group_tna_stability(), print.summary.group_tna_bootstrap(), print.summary.tna_bootstrap(), print.summary.tna_markov_order(), print.tna_bootstrap(), print.tna_markov_order(), print.tna_permutation(), print.tna_reliability(), print.tna_stability(), prune(), pruning_details(), reliability(), reprune(), summary.group_tna_bootstrap(), summary.tna_bootstrap(), summary.tna_markov_order(), summary.tna_reliability(), summary.tna_stability()

Examples

model <- group_model(engagement_mmm)
# Small number of iterations for CRAN
perm <- permutation_test(model, iter = 20, measures = "InStrength")
summary(perm)
summary(perm, what = "centralities")


tna documentation built on Nov. 17, 2026, 1:06 a.m.