head.epichains {epichains}R Documentation

head and tail method for ⁠<epichains>⁠ class

Description

head and tail method for ⁠<epichains>⁠ class

Usage

## S3 method for class 'epichains'
head(x, ...)

## S3 method for class 'epichains'
tail(x, ...)

Arguments

x

An ⁠<epichains>⁠ object.

...

Further arguments passed to or from other methods.

Details

This returns the top rows of an ⁠<epichains>⁠ object, starting from the first known infectors.

To view the full output, use ⁠as.data.frame(<object_name>)⁠.

Value

An object of class ⁠<data.frame>⁠.

Author(s)

James M. Azam

Examples

set.seed(32)
chains_pois_offspring <- simulate_chains(
  n_chains = 10,
  statistic = "size",
  offspring_dist = rpois,
  stat_threshold = 10,
  generation_time = function(n) rep(3, n),
  lambda = 2
)
head(chains_pois_offspring)
set.seed(32)
chains_pois_offspring <- simulate_chains(
  n_chains = 10,
  statistic = "size",
  offspring_dist = rpois,
  stat_threshold = 10,
  generation_time = function(n) rep(3, n),
  lambda = 2
)
tail(chains_pois_offspring)

[Package epichains version 0.1.1 Index]