EpiModel (version 0.95)

summary.epiICM: Summary Model Statistics

Description

This function extracts and prints model statistics solved with the epiICM function.

Usage

## S3 method for class 'epiICM':
summary(object, time, digits = 3, comp.plot = FALSE, ...)

Arguments

object

an EpiModel object of class epiICM.

time

time step for model statistics.

digits

number of significant digits to print.

comp.plot

if TRUE, plot compartments and flows in summary. This can be called separately using the comp.plot function.

...

additional summary function arguments.

Details

Summary statistics for the main epidemiological outcomes (state and transition size and prevalence) from an epiICM model. Time-specific summary measures are provided, so it is necessary to input a time of interest. One may simultaneously obtain console-based statistics and a compartment plot via the comp.plot function through the comp.plot argument.

See Also

epiICM, comp.plot

Examples

# Stochastic SI model with 10 simulations
mod <- epiICM(type = "SI", s.num = 500, i.num = 1,
              trans.rate = 0.2, act.rate = 0.25,
              nsteps = 500, nsims = 10)
summary(mod, time = 25)
summary(mod, time = 50, comp.plot = TRUE)