PlotEpiTree: Plot the spread of an epidemic

Description

Plot the spread of an epidemic over a contact network.

Usage

plotepitree(epi, lwd = 1, leaf.labs = TRUE, leaf.cex = 0.75, 
    zero.at.start = FALSE, main = "Spread of Epidemic", xlab = "Time", 
    ylab= "",e.col = "black", i.col = "red", lty.transmission = 3, 
    marktransitions = TRUE, label.trans = "|", cex.trans = 0.5, ...)
plotepitreemcmc(mcmcoutput, index = lastiteration, lwd = 1, 
    leaf.labs = TRUE, leaf.cex = 0.75, zero.at.start = FALSE, 
    main = "Spread of Epidemic", xlab = "Time", ylab= "", 
    e.col = "black", i.col = "red", lty.transmission = 3, 
    marktransitions = TRUE, label.trans = "|", cex.trans = 0.5, ...)

Arguments

epi

a simulated epidemic, in the form of the output produced by SEIR.simulator.

mcmcoutput

output from epibayesmcmc.

index

a number indicating which of the MCMC samples to plot. Defaults to the final sample in the chain.

lwd

line width for the (horizontal) line segments representing the exposed and infective periods for each individual. Also controls the line width for the (vertical) line segments showing the transmission pathways.

leaf.labs

boolean variable controlling whether the leaf labels (Node IDs) are displayed to the right of their infective period. Defaults to TRUE.

leaf.cex

Character expansion factor for the leaf labels, if they are displayed. Defaults to 0.75.

zero.at.start

boolean variable governing whether the epidemic times are shifted so that the epidemic begins at time zero. Defaults to FALSE.

main

main title for plot.

xlab

label for x axis on plot. Defaults to Time.

ylab

label for y axis on plot. Defaults to blank.

e.col

color to be used to plot the individuals' exposed periods on the plot. Defaults to black.

i.col

color to be used to plot the individuals' infective periods on the plot. Defaults to red.

lty.transmission

line type used to mark the (vertical) infection pathway on the plot. Defaults to 3 (dotted).

marktransitions

boolean variable indicating whether tick marks should be placed at the times where the individuals move from the exposed to the infective state. Defaults to TRUE.

label.trans

character used to mark transition points, if marktransitions is TRUE. Defaults to |.

cex.trans

magnification to be used to for transition labels, if marktransitions is TRUE. Defaults to 0.5.

...

other plotting arguments to be passed through to the call to plot() that draws the axes and titles.

Value

returns no value. Strictly invoked for the plotting side effect.

Details

Takes as input either a simulated epidemic, or the output from an MCMC output (which itself may infer the epidemic times) and plots them, indicating the path that the infection took during the epidemic (the transmission tree) and the times that each node entered the Exposed, Infective, and Removed states. The default plotting parameter values work well for epidemics up to about 50 - 60 infecteds.

Examples

Run this code

# Simulate an epidemic through a network of 30
set.seed(1)
examplenet <- buildER(30, 0.1)
exampleepidemic <- SEIR.simulator(examplenet, 30, 0.3, 2, 5, 
    latencydist="gamma")

# Plot the simulated epidemic
plotepitree(exampleepidemic)

# Run MCMC algorithm on this epidemic
examplemcmc <- epibayesmcmc(exampleepidemic, nsamp = 100000, 
    thinning = 1000, bprior = c(0, 1), tiprior = c(0, 5), teprior = c(0, 5),
    kiprior = c(0, 10), keprior = c(0, 10), N = 30, priordists = "uniform", 
    extrathinning = 10, inferEtimes = TRUE, inferItimes = TRUE)

# Plot starting state of epidemic from chain 
plotepitreemcmc(examplemcmc, index = 1)

# Plot final state of epidemic from chain 
plotepitreemcmc(examplemcmc)