Learn R Programming

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

surveillance (version 1.9-1)

Temporal and Spatio-Temporal Modeling and Monitoring of Epidemic Phenomena

Description

Implementation of 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, or continuous-space point process data such as the occurrence of infectious diseases. Main focus is on outbreak detection in count data time series originating from public health surveillance of communicable diseases, but applications could just as well originate from environmetrics, reliability engineering, econometrics or social sciences. Currently, the package contains implementations of many typical outbreak detection procedures such as Farrington et al (1996), Noufaily et al (2012) or the negative binomial LR-CUSUM method described in H�hle and Paul (2008). A novel CUSUM approach combining logistic and multinomial logistic modelling is also included. Furthermore, inference methods for the retrospective infectious disease models in Held et al (2005), Held et al (2006), Paul et al (2008), Paul and Held (2011), Held and Paul (2012), and Meyer and Held (2014) are provided. 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 data sets, the ability to simulate outbreak data, visualize the results of the monitoring in temporal, spatial or spatio-temporal fashion. Note: Using the 'boda' algorithm requires the 'INLA' package, which should be installed automatically through the specified Additional_repositories, if uninstalled dependencies are also requested. As this might not work under OS X it might be necessary to manually install the 'INLA' package as specified at .

Copy Link

Version

Install

install.packages('surveillance')

Monthly Downloads

1,593

Version

1.9-1

License

GPL-2

Maintainer

Michael Hhle

Last Published

June 12th, 2015

Functions in surveillance (1.9-1)

algo.cdc

The CDC Algorithm
algo.farrington

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

Modified CUSUM method as proposed by Rogerson and Yamada (2004)
epidata_summary

Summarizing an Epidemic
epidataCS_permute

Randomly Permute Time Points or Locations of "epidataCS"
algo.rki

The system used at the RKI
hhh4_W

Power-Law and Nonparametric Neighbourhood Weights for hhh4-Models
predict.ah

Predictions from a HHH model
disProg2sts

Convert disProg object to sts and vice versa
algo.cusum

CUSUM method
addSeason2formula

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

Summary Table Generation for Several Disease Chains
pit

Non-Randomized Version of the PIT Histogram (for Count Data)
algo.farrington.assign.weights

Assign weights to base counts
epidata

Continuous-Time SIR Event History of a Fixed Population
salmNewport

Salmonella Newport cases in Germany 2004-2013
compMatrix.writeTable

Latex Table Generation
isScalar

Checks if the Argument is Scalar
algo.glrnb

Count Data Regression Charts
epidataCS_animate

Spatio-Temporal Animation of a Continuous-Time Continuous-Space Epidemic
algo.outbreakP

Semiparametric surveillance of outbreaks
makePlot

Plot Generation
stsSlot-generics

Generic functions to access "sts" slots
create.disProg

Creating an object of class disProg
hepatitisA

Hepatitis A in Germany
primeFactors

Prime number factorization
coeflist

List Coefficients by Model Component
hhh4_predict

Predictions from a hhh4 Model
deleval

Surgical failures data
algo.bayes

The Bayes System
enlargeData

Data Enlargement
epidataCS

Continuous Space-Time Marked Point Patterns with Grid-Based Covariates
layout.labels

Layout Items for spplot
loglikelihood

Calculation of the loglikelihood needed in algo.hhh
isoWeekYear

Find ISO week and ISO year of a vector of Date objects on Windows
hhh4_methods

Print, Summary and other Standard Methods for "hhh4" Objects
measlesDE

Measles in the 16 states of Germany
hhh4_validation

Predictive Model Assessment for hhh4 Models
stcd

Spatio-temporal cluster detection
plot.atwins

Plot results of a twins model fit
plot.hhh4

Plots for Fitted hhh4-models
twinstim_methods

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

Surveillance for an univariate count data time series using the Bayesian Outbreak Detection Algorithm (BODA) described in Manitz and H�hle{Hoehle} (2013)
meanResponse

Calculate mean response needed in algo.hhh
qlomax

Quantile Function of the Lomax Distribution
ha

Hepatitis A in Berlin
aggregate-methods

Aggregate the the series of an sts object
print.algoQV

Print quality value object
sim.seasonalNoise

Generation of Background Noise for Simulated Timeseries
sts_animate

Animated Maps and Time Series of Disease Incidence
arlCusum

Calculation of Average Run Length for discrete CUSUM schemes
twinstim_epitest

Permutation Test for Space-Time Interaction in "twinstim"
epidata_plot

Plotting the Evolution of an Epidemic
stsNC-class

Class "stsNC" -- a class inheriting from class sts which allows the user to store the results of back-projecting surveillance time series
epidata_intersperse

Impute Blocks for Extra Stops in "epidata" Objects
stsplot

Plot-Methods for Surveillance Time-Series Objects
momo

Danish 1994-2008 all cause mortality data for six age groups
twinstim_plot

Plot methods for fitted twinstim's
glm_epidataCS

Fit an Endemic-Only twinstim as a Poisson-glm
[,sts-methods

Extraction and Subsetting of sts objects
create.grid

Computes a matrix of initial values
twinstim_step

Stepwise Model Selection by AIC
farringtonFlexible

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

Measles in the Weser-Ems region of Lower Saxony, Germany, 2001-2002
intersectPolyCircle

Intersection of a Polygonal and a Circular Domain
MMRcoverageDE

MMR coverage levels in the 16 states of Germany
plapply

Verbose and Parallel lapply
stsplot_spacetime

Map of Disease Incidence
epidataCS_update

Update method for "epidataCS"
discpoly

Polygonal Approximation of a Disc/Circle
untie

Randomly Break Ties in Data
m1

RKI SurvStat Data
algo.twins

Model fit based on a two-component epidemic model
pairedbinCUSUM

Paired binary CUSUM and its run-length computation
simHHH

Simulates data based on the model proposed by Held et. al (2005)
testSim

Print xtable for a Simulated Disease and the Summary
formatPval

Pretty p-Value Formatting
sim.pointSource

Generation of Simulated Point Source Epidemy
twinSIR_cox

Identify Endemic Components in an Intensity Model
algo.farrington.fitGLM

Fit the Poisson GLM of the Farrington procedure for a single time point
aggregate.disProg

Aggregate the observed counts
twinSIR_profile

Profile Likelihood Computation and Confidence Intervals
algo.call

Query Transmission to Specified Surveillance Algorithm
backprojNP

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

Determine Neighbourhood Order Matrix from Binary Adjacency Matrix
salmHospitalized

Hospitalized Salmonella cases in Germany 2004-2014
marks

Import from package spatstat
make.design

Create the design matrices
nowcast

Adjust a univariate time series of counts for observed but-not-yet-reported events
multiplicity

Import from package spatstat
residualsCT

Extract Cox-Snell-like Residuals of a Fitted Point Process
earsC

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

Plotting the Events of an Epidemic over Time and Space
algo.hmm

Hidden Markov Model (HMM) method
rotaBB

Rotavirus cases in Brandenburg, Germany, during 2002-2013 stratified by 5 age categories
scale.gpc.poly

Centering and Scaling a "gpc.poly" Polygon
abattoir

Abattoir Data
knox

Knox Test for Space-Time Interaction
anscombe.residuals

Compute Anscombe residuals
algo.quality

Computation of Quality Values for a Surveillance System Result
sts-class

Class "sts" -- surveillance time series
findH

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

Generic animation of spatio-temporal objects
epidata_animate

Spatio-Temporal Animation of an Epidemic
stsplot_time

Time-Series Plots for "sts" Objects
twinstim

Fit a Two-Component Spatio-Temporal Point Process Model
campyDE

Cases of Campylobacteriosis and Absolute Humidity in Germany 2002-2011
intensityplot

Plot Paths of Point Process Intensities
algo.farrington.threshold

Compute prediction interval for a new observation
categoricalCUSUM

CUSUM detector for time-varying categorical time series
hhh4

Fitting HHH Models with Random Effects and Neighbourhood Structure
hagelloch

1861 Measles Epidemic in the City of Hagelloch, Germany
ks.plot.unif

Plot the ECDF of a uniform sample with Kolmogorov-Smirnov bounds
algo.compare

Comparison of Specified Surveillance Systems using Quality Values
multiplicity.Spatial

Count Number of Instances of Points
readData

Reading of Disease Data
magic.dim

Returns a suitable k1 x k2 for plotting the disProgObj
polyAtBorder

Indicate Polygons at the Border
shadar

Salmonella Hadar cases in Germany 2001-2006
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
influMen

Influenza and meningococcal infections in Germany, 2001-2006
bestCombination

Partition of a number into two factors
correct53to52

Data Correction from 53 to 52 weeks
hhh4_update

update a fitted "hhh4" model
toFileDisProg

Writing of Disease Data
twinstim_iafplot

Plot the spatial or temporal interaction function of a twimstim
twinSIR_simulation

Simulation of Epidemic Data
surveillance.options

Options of the surveillance Package
find.kh

Determine the k and h values in a standard normal setting
LRCUSUM.runlength

Run length computation of a CUSUM detector
hhh4_formula

Specify Formulae in a Random Effects HHH Model
salmNewportTruncated

Salmonella Newport cases in Germany 2001-2011 by data of symptoms onset
sts_creation

Function for simulating a time series
fluBYBW

Influenza in Southern Germany
permutationTest

Monte Carlo Permutation Test for Paired Individual Scores
bodaDelay

Bayesian aberration detection in presence of reporting delays.
checkResidualProcess

Check the residual process of a fitted twinSIR or twinstim
imdepi

Occurrence of Invasive Meningococcal Disease in Germany
algo.hhh

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

Salmonella cases in Germany 2001-2014 by data of symptoms onset
siaf.simulatePC

Simulation from an Isotropic Spatial Kernel via Polar Coordinates
residuals.ah

Residuals from a HHH model
test

Print xtable for several diseases and the summary
refvalIdxByDate

Compute indices of reference value using Date class
husO104Hosp

Hospitalization date for HUS cases of the STEC outbreak in Germany, 2011
stsplot_space

Map of Disease Incidence During a Given Period
algo.hhh.grid

Function to try multiple starting values
estimateGLRNbHook

Hook function for in-control mean estimation
toLatex.sts

toLatex-Method for (lists of) "sts" Objects
sts_observation

Function for creating a sts-object with a given observation date
salmonella.agona

Salmonella Agona cases in the UK 1990-1995
twinSIR_intensityplot

Plotting Paths of Infection Intensities for twinSIR Models
surveillance-package

[stage=build]{(meta <- packageDescription("surveillance", encoding="latin1"))$Title} [stage=build]{meta$Description}
ll{ Package: [stage=build]{meta$Package} Version: [stage=build]{meta$Version} License: [stage=build]{meta$License} URL: http://surveillance.r-forge.r-project.org/ surveillance is an Rpackage implementing statistical methods for the retrospective modeling and prospective change-point detection in time series of counts, proportions and categorical data. The main application is in the detection of aberrations in routine collected public health data seen as univariate and multivariate time series of counts or point-processes. However, applications could just as well originate from environmetrics, econometrics or social sciences. As many methods rely on statistical process control methodology, the package is thus also relevant to quality control and reliability engineering. The fundamental data structure of the package is an S4 class sts wrapping observations, monitoring results and date handling for multivariate time series. Currently the package contains implementations 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 (H{oe}hle, 2007), negative binomial CUSUM methods (H{oe}hle and Mazick, 2009), and a detector based on generalized likelihood ratios (H{oe}hle and Paul, 2008). However, also CUSUMs for the prospective change-point detection in binomial, beta-binomial and multinomial time series is covered based on generalized linear modelling. This includes e.g. paired binary CUSUM described by Steiner et al. (1999) or paired comparison Bradley-Terry modelling described in H{oe}hle (2010). 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. Furthermore, the package contains inference methods for the retrospective infectious disease model in Held et al. (2005), Paul et al. (2008) ("algo.hhh") and Paul and Held (2011) ("hhh4") handling multivariate time series of counts. Furthermore, the fully Bayesian approach for univariate time series of counts from Held et al. (2006) ("twins") is also implemented. Self-exciting spatio-temporal point processes are modeled through additive-multiplicative conditional intensities as described in H{oe}hle (2009) ("twinSIR") and Meyer et al (2012) ("twinstim"). Altogether, the package allows the modelling and monitoring of epidemic phenomena in temporal and spatio-temporal contexts.[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
sumNeighbours

Calculates the sum of counts of adjacent areas
twinSIR_exData

Toy Data for twinSIR
twinSIR_methods

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

Spatial Interaction Function Objects
twinstim_profile

Profile Likelihood Computation and Confidence Intervals for twinstim objects
linelist2sts

Convert individual case information based on dates into an aggregated time series of counts
epidataCS_aggregate

Conversion (aggregation) of "epidataCS" to "epidata" or "sts"
poly2adjmat

Derive Adjacency Structure of "SpatialPolygons"
hhh4_simulate

Simulates data based on the model proposed by Paul and Held (2011)
plot.survRes

Plot a survRes object
runifdisc

Sample Points Uniformly on a Disc
twinstim_intensity

Plotting Intensities of Infection over Time or Space
zetaweights

Power-Law Weights According to Neighbourhood Order
twinstim_iaf

Temporal and Spatial Interaction Functions for twinstim
unionSpatialPolygons

Compute the Unary Union of "SpatialPolygons"
wrap.algo

Multivariate Surveillance through independent univariate algorithms
twinstim_tiaf

Temporal Interaction Function Objects
findK

Find reference value
R0

Computes reproduction numbers from fitted models
inside.gpc.poly

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

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

Hook function for in-control mean estimation
algo.glrpois

Poisson regression charts
plot.disProg

Plot Generation of the Observed and the defined Outbreak States of a (multivariate) time series
stK

Diggle et al (1995) K-function test for space-time clustering
twinSIR

Fit an Additive-Multiplicative Intensity Model for SIR Data
xtable.algoQV

Xtable quality value object
twinstim_update

update-method for "twinstim"