summary.dynet_metric: Summarise a temporal measure

View source: R/result.R

summary.dynet_metricR Documentation

Summarise a temporal measure

Description

Collapses the time dimension. Node-level measures are summarised one row per vertex and measure; graph-level measures one row per measure. The peak time is reported alongside, because when a quantity peaked is usually the question a temporal network is being asked.

Usage

## S3 method for class 'dynet_metric'
summary(object, by = NULL, ...)

Arguments

object

A dynet_metric.

by

Grouping for the summary: "node", "time" or "measure". The default, NULL, groups by "node" when the measure has a node column and by "measure" otherwise. A session column, when the measure has one, and measure itself are always part of the grouping as well. A grouping the measure has no column for – "node" on a graph-level series, say – is dropped rather than raising, leaving the grouping the measure does carry.

...

Ignored.

Value

A data.frame with the grouping columns plus n, mean, sd, min, max and, when time is available, peak_time. n counts the measured values the statistics were computed from, so a vertex that was inactive for part of the calendar reports fewer than the number of time points.

Examples

dn <- dynet(school_contacts)
degree <- centrality_series(dn, measure = "degree")
summary(degree)
summary(degree, by = "time")


Dynet documentation built on Oct. 7, 2026, 5:08 p.m.