Learn R Programming

⚠️There's a newer version (1.25.0) of this package.Take me there.

surveillance (version 1.6-0)

Temporal and Spatio-Temporal Modeling and Monitoring of Epidemic Phenomena

Description

A package implementing statistical methods for the modeling and change-point detection in time series of counts, proportions and categorical data, as well as for the modeling of continuous-time epidemic phenomena, e.g. discrete-space setups such as the spatially enriched Susceptible-Exposed-Infectious-Recovered (SEIR) models for surveillance data, or continuous-space point process data such as the occurrence of disease or earthquakes. Main focus is on outbreak detection in count data time series originating from public health surveillance of infectious diseases, but applications could just as well originate from environmetrics, reliability engineering, econometrics or social sciences. Currently the package contains implementations of typical outbreak detection procedures such as Stroup et. al (1989), Farrington et al (1996), Rossi et al (1999), Rogerson and Yamada (2001), a Bayesian approach, negative binomial CUSUM methods and a detector based on generalized likelihood ratios. Furthermore, inference methods for the retrospective infectious disease model in Held et al (2005), Held et al (2006), Paul et al (2008) and Paul and Held (2011) are provided. A novel CUSUM approach combining logistic and multinomial logistic modelling is also included. Continuous self-exciting spatio-temporal point processes are modeled through additive-multiplicative conditional intensities as described in H�hle (2009) ("twinSIR", discrete space) and Meyer et al (2012) ("twinstim", continuous space). The package contains several real-world datasets, the ability to simulate outbreak data, visualize the results of the monitoring in temporal, spatial or spatio-temporal fashion.

Copy Link

Version

Install

install.packages('surveillance')

Monthly Downloads

1,063

Version

1.6-0

License

GPL-2

Maintainer

Michael Hhle

Last Published

September 9th, 2013

Functions in surveillance (1.6-0)

addSeason2formula

Function that adds a sine-/cosine formula to an existing formula.
bestCombination

Partition of a number into two factors
hepatitisA

Hepatitis A in Germany
create.grid

Computes a matrix of initial values
runifdisc

Sample Points Uniformly on a Disc
momo

Danish 1994-2008 all cause mortality data for six age groups
print.algoQV

Print quality value object
sim.pointSource

Generation of Simulated Point Source Epidemy
algo.farrington

Surveillance for a count data time series using the Farrington method.
algo.summary

Summary Table Generation for Several Disease Chains
sim.seasonalNoise

Generation of Background Noise for Simulated Timeseries
hhh4_validation

Predictive Model Assessment for HHH4 models
toFileDisProg

Writing of Disease Data
twinSIR_epidata_animate

Spatio-Temporal Animation of an Epidemic
meanResponse

Calculate mean response needed in algo.hhh
imdepi

Occurrence of Invasive Meningococcal Disease in Germany
algo.farrington.threshold

Compute prediction interval for a new observation
algo.cusum

CUSUM method
algo.hhh.grid

Function to try multiple starting values
twinSIR_epidata_intersperse

Impute Blocks for Extra Stops in "epidata" Objects
primeFactors

Prime number factorization
twinSIR_profile

Profile Likelihood Computation and Confidence Intervals
twinstim_epidataCS_aggregate

Conversion (aggregation) of "epidataCS" to "epidata" or "sts"
xtable.algoQV

Xtable quality value object
twinstim_epidataCS_animate

Spatio-Temporal Animation of a Continuous-Time Continuous-Space Epidemic
pairedbinCUSUM

Paired binary CUSUM and its run-length computation
findH

Find decision interval for given in-control ARL and reference value
stcd

Spatio-temporal cluster detection
aggregate-methods

Aggregate the the series of an sts object
untie

Randomly Break Ties in Data
measlesDE

Measles in the 16 states of Germany
twinstim_methods

Print, Summary and Extraction Methods for "twinstim" Objects
twinstim_intensityplot

Plotting Intensities of Infection over Time or Space
ks.plot.unif

Plot the ECDF of a uniform sample with Kolmogorov-Smirnov bounds
deleval

Surgical failures data
LRCUSUM.runlength

Run length computation of a CUSUM detector
algo.compare

Comparison of Specified Surveillance Systems using Quality Values
algo.rogerson

Modified CUSUM method as proposed by Rogerson and Yamada (2004)
algo.farrington.assign.weights

Assign weights to base counts
residuals.ah

Residuals from a HHH model
arlCusum

Calculation of Average Run Length for discrete CUSUM schemes
twinSIR

Spatio-Temporal Epidemic Modelling Using Additive-Multiplicative Intensity Models
make.design

Create the design matrices
animate

Generic animation of spatio-temporal objects
formatPval

Pretty p-Value Formatting
correct53to52

Data Correction from 53 to 52 weeks
twinSIR_methods

Print, Summary and Extraction Methods for "twinSIR" Objects
checkResidualProcess

Check the residual process of a fitted twinSIR or twinstim
estimateGLRPoisHook

Hook function for in-control mean estimation
hagelloch

1861 measles epidemic in the city of Hagelloch, Germany
predict.ah4

Predictions from a hhh4 Model
isScalar

Checks if the Argument is Scalar
twinstim_step

Stepwise Model Selection by AIC
plot.atwins

Plot results of a twins model fit
fluBYBW

Influenza in Southern Germany
qlomax

Quantile Function of the Lomax Distribution
simHHH

Simulates data based on the model proposed by Held et. al (2005)
stsSlot-generics

Generic functions to access "sts" slots
testSim

Print xtable for a Simulated Disease and the Summary
test

Print xtable for several diseases and the summary
stsBP-class

Class "stsBP" -- a class inheriting from class sts which allows the user to store the results of back-projecting or nowcasting surveillance time series
twinSIR_exData

Artificial data and data from the German Federal State Baden-Wuerttemberg
refvalIdxByDate

Compute indices of reference value using Date class
twinSIR_simulation

Simulation of Epidemic Data
readData

Reading of Disease Data
plot.disProg

Plot Generation of the Observed and the defined Outbreak States of a (multivariate) time series
wrap.algo

Multivariate Surveillance through independent univariate algorithms
twinSIR_cox

Identify Endemic Components in an Intensity Model
twinstim_update

update-method for "twinstim"
estimateGLRNbHook

Hook function for in-control mean estimation
intensityplot

Plot Paths of Point Process Intensities
disProg2sts

Convert disProg object to sts and vice versa
makePlot

Plot Generation
farringtonFlexible

Surveillance for an univariate count data time series using the improved Farrington method described in Noufaily et al. (2012).
multiplicity

Count Number of Instances of Points
twinSIR_epidata

Class for Epidemic Data Discrete in Space and Continuous in Time
m1

RKI SurvStat Data
residualsCT

Extract Cox-Snell-like Residuals of a Fitted Point Process
scale.gpc.poly

Centering and Scaling a "gpc.poly" Polygon
twinstim_epidataCS

Class for Representing Continuous Space-Time Point Process Data
aggregate.disProg

Aggregate the observed counts
hhh4_formula

Specify Formulae in a Random Effects HHH Model
algo.hhh

Model fit based on the Held, Hoehle, Hofman paper
influMen

Influenza and meningococcal infections in Germany, 2001-2006
sumNeighbours

Calculates the sum of counts of adjacent areas
backprojNP

Non-parametric back-projection of incidence cases to exposure cases using a known incubation time as in Becker et al (1991).
nowcast

Adjust observed epidemic curve for reporting delay of cases
algo.call

Query Transmission to Specified Surveillance Systems
algo.hmm

Hidden Markov Model (HMM) method
predict.ah

Predictions from a HHH model
algo.quality

Computation of Quality Values for a Surveillance System Result
algo.outbreakP

Semiparametric surveillance of outbreaks
twinstim_profile

Profile Likelihood Computation and Confidence Intervals for twinstim objects
ha

Hepatitis A in Berlin
nbOrder

Determine Neighbourhood Order Matrix from Binary Adjacency Matrix
algo.rki

The system used at the RKI
twinSIR_intensityplot

Plotting Paths of Infection Intensities for twinSIR Models
anscombe.residuals

Compute Anscombe residuals
earsC

Surveillance for a count data time series using the EARS C1, C2 or C3 method.
find.kh

Determine the k and h values in a standard normal setting
display-methods

Display Methods for Surveillance Time-Series Objects
twinstim_iafplot

Plot the spatial or temporal interaction function of a twimstim
hhh4

Random effects HHH model fit as described in Paul and Held (2011)
surveillance-package

Temporal and Spatio-Temporal Modeling and Monitoring of Epidemic Phenomena
plot.survRes

Plot a survRes object
isoWeekYear

Find ISO week and ISO year of a vector of Date objects
R0

Computes basic reproduction numbers from fitted models
algo.bayes

The Bayes System
algo.cdc

The CDC Algorithm
categoricalCUSUM

CUSUM detector for time-varying categorical time series
create.disProg

Creating an object of class disProg
enlargeData

Data Enlargement
algo.glrpois

Poisson regression charts
findK

Find reference value
sts-class

Class "sts" -- surveillance time series
linelist2sts

Convert individual case information based on dates into an aggregated time series
measles.weser

Measles epidemics in Lower Saxony in 2001-2002
magic.dim

Returns a suitable k1 x k2 for plotting the disProgObj
inside.gpc.poly

Test Whether Points are Inside a "gpc.poly" Polygon
twinstim_epidataCS_update

Update method for "epidataCS"
powerlaw

Power-Law Neighbourhood Weights for hhh4 Models
simulate.ah4

Simulates data based on the model proposed by Paul and Held (2011)
abattoir

Abattoir Data
hhh4_methods

Print, Summary and Extraction Methods for "ah4" Objects
MMRcoverageDE

MMR coverage levels in the 16 states of Germany
salmonella.agona

Salmonella Agona cases in the UK 1990-1995
twinSIR_epidata_plot

Plotting the Evolution of an Epidemic
zetaweights

Power-Law Weights According to Neighbourhood Order
algo.glrnb

Cound data regression charts
loglikelihood

Calculation of the loglikelihood needed in algo.hhh
poly2adjmat

Derive Adjacency Structure of "SpatialPolygons"
twinstim_epidataCS_plot

Plotting the Events of an Epidemic over Time and Space
twinstim_simulation

Simulation of a Self-Exciting Spatio-Temporal Point Process
twinstim_plot

Plot methods for fitted twinstim's
algo.twins

Model fit based on a two-component epidemic model
compMatrix.writeTable

Latex Table Generation
twinstim

Fit a Two-Component Spatio-Temporal Conditional Intensity Model
twinSIR_epidata_summary

Summarizing an Epidemic
twinstim_iaf

Temporal and Spatial Interaction Functions for twinstim
polyAtBorder

Indicate Polygons at the Border
shadar

Salmonella Hadar cases in Germany 2001-2006
algo.farrington.fitGLM

Fit the Poisson GLM of the Farrington procedure for a single time point
surveillance.options

Options of the surveillance Package
[,sts-methods

Extraction and Subsetting of sts objects