summary.epichains_summary: Summary method for <epichains_summary> class

In epichains: Simulating and Analysing Transmission Chain Statistics Using Branching Process Models

Summary method for ⁠<epichains_summary>⁠ class

Description

Summary method for ⁠<epichains_summary>⁠ class

Usage

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

Arguments

object	An ⁠<epichains_summary>⁠ object.
...	Not used.

Value

A list of chain summaries. The list contains the following elements:

• n_chains: the number of chains simulated.

• max_stat: the maximum chain statistic (size/length) achieved by the chains.

• min_stat: the minimum chain statistic (size/length) achieved by the chains.

Author(s)

James M. Azam

Examples

# Using a Poisson offspring distribution and simulating from an infinite
# population up to chain size 10.
set.seed(32)
chain_stats <- simulate_chain_stats(
  n_chains = 10,
  statistic = "size",
  offspring_dist = rpois,
  stat_threshold = 10,
  lambda = 2
)
summary(chain_stats)

epichains documentation built on Oct. 14, 2024, 5:10 p.m.