summary.chain_structure: Tidy per-state summary of a 'chain_structure'

View source: R/chain_structure.R

summary.chain_structureR Documentation

Tidy per-state summary of a chain_structure

Description

Returns a single data.frame with one row per state, combining every per-state metric chain_structure() computes. Always includes state, classification, period, return_probability (the diagonal of the hitting matrix) and persistence (the diagonal of the transition matrix); adds sojourn whenever it is finite, the chain's stationary_probability when irreducible, and absorption columns when the chain has any absorbing states.

Usage

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

Arguments

object

A chain_structure object.

...

Ignored.

Details

Columns are ordered for readability: identifiers first, classification second, dynamic per-state metrics last.

Value

A data.frame with one row per state. Columns described above.


Nestimate documentation built on July 11, 2026, 1:09 a.m.