EpiModel (version 0.95)

summary.epiDCM: Summary Model Statistics

Description

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

Usage

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

Arguments

object

an EpiModel object of class epiDCM.

time

time step for model statistics.

run

run number for model, if sensitivity analyses were conducted through epiDCM.

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 epiDCM model. Time-specific summary measures are provided, so it is necessary to input a time of interest. For multiple-run models (e.g., sensitivity analyses), one may also input a model run number. See the examples below.

See Also

epiDCM

Examples

# Deterministic SIR model with varying act.rate
mod <- epiDCM(type="SIR", s.num=1000, i.num=1, r.num=0,
              trans.rate=0.2, act.rate=2:8, rec.rate=1/3,
              b.rate=0.011, ds.rate=0.01, di.rate=0.03,
              dr.rate=0.01, nsteps=500, verbose=TRUE)
summary(mod, time=25, run=1, comp.plot=TRUE)
summary(mod, time=25, run=7, comp.plot=TRUE)
summary(mod, time=26, run=7, comp.plot=TRUE)