Learn R Programming

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

surveillance (version 1.8-2)

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 Farrington et al (1996), Noufaily et al (2012) or the negative binomial LR-CUSUM method described in Hoehle and Paul (2008). 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 data sets, the ability to simulate outbreak data, visualize the results of the monitoring in temporal, spatial or spatio-temporal fashion. Note: The suggested package INLA is unfortunately not available from any mainstream repository - in case one wants to use the 'boda' algorithm one needs to manually install the INLA package as specified at http://www.r-inla.org/download.

Copy Link

Version

Install

install.packages('surveillance')

Monthly Downloads

1,593

Version

1.8-2

License

GPL-2

Maintainer

Michael Hhle

Last Published

December 20th, 2014

Functions in surveillance (1.8-2)

epidata

Continuous-Time SIR Event History of a Fixed Population
algo.call

Query Transmission to Specified Surveillance Algorithm
algo.farrington.fitGLM

Fit the Poisson GLM of the Farrington procedure for a single time point
algo.hhh.grid

Function to try multiple starting values
algo.cdc

The CDC Algorithm
intersectPolyCircle

Intersection of a Polygonal and a Circular Domain
primeFactors

Prime number factorization
marks

Import from package spatstat
stsplot_spacetime

Map of Disease Incidence
create.disProg

Creating an object of class disProg
correct53to52

Data Correction from 53 to 52 weeks
algo.hhh

Model fit based on the Held, Hoehle, Hofman paper
algo.compare

Comparison of Specified Surveillance Systems using Quality Values
aggregate.disProg

Aggregate the observed counts
fluBYBW

Influenza in Southern Germany
test

Print xtable for several diseases and the summary
algo.twins

Model fit based on a two-component epidemic model
twinstim_tiaf

Temporal Interaction Function Objects
hhh4_validation

Predictive Model Assessment for hhh4 Models
inside.gpc.poly

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

Calculation of Average Run Length for discrete CUSUM schemes
algo.outbreakP

Semiparametric surveillance of outbreaks
influMen

Influenza and meningococcal infections in Germany, 2001-2006
anscombe.residuals

Compute Anscombe residuals
epidata_animate

Spatio-Temporal Animation of an Epidemic
epidata_summary

Summarizing an Epidemic
meanResponse

Calculate mean response needed in algo.hhh
stsplot_time

Time-Series Plots for "sts" Objects
algo.glrnb

Count Data Regression Charts
hhh4_simulate

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

Hepatitis A in Berlin
categoricalCUSUM

CUSUM detector for time-varying categorical time series
m1

RKI SurvStat Data
formatPval

Pretty p-Value Formatting
epidataCS_animate

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

Predictions from a hhh4 Model
measles.weser

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

Hepatitis A in Germany
ks.plot.unif

Plot the ECDF of a uniform sample with Kolmogorov-Smirnov bounds
salmonella.agona

Salmonella Agona cases in the UK 1990-1995
twinSIR_intensityplot

Plotting Paths of Infection Intensities for twinSIR Models
hhh4_formula

Specify Formulae in a Random Effects HHH Model
shadar

Salmonella Hadar cases in Germany 2001-2006
twinstim_siaf

Spatial Interaction Function Objects
make.design

Create the design matrices
findH

Find decision interval for given in-control ARL and reference value
predict.ah

Predictions from a HHH model
hhh4_methods

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

Plot-Methods for Surveillance Time-Series Objects
twinSIR_exData

Toy Data for twinSIR
twinSIR

Fit an Additive-Multiplicative Intensity Model for SIR Data
multiplicity.Spatial

Count Number of Instances of Points
twinstim_profile

Profile Likelihood Computation and Confidence Intervals for twinstim objects
stcd

Spatio-temporal cluster detection
linelist2sts

Convert individual case information based on dates into an aggregated time series
epidataCS

Continuous Space-Time Marked Point Patterns with Grid-Based Covariates
sumNeighbours

Calculates the sum of counts of adjacent areas
surveillance-package

[stage=build]{(meta <- packageDescription("surveillance", encoding="latin1"))$Title} A package implementing statistical methods for the modelling 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{oe}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.
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]
epidataCS_aggregate

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

Xtable quality value object
nowcast

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

1861 Measles Epidemic in the City of Hagelloch, Germany
wrap.algo

Multivariate Surveillance through independent univariate algorithms
permutationTest

Monte Carlo Permutation Test for Paired Individual Scores
algo.farrington

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

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

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

Computes basic reproduction numbers from fitted models
algo.farrington.threshold

Compute prediction interval for a new observation
isoWeekYear

Find ISO week and ISO year of a vector of Date objects on Windows
algo.cusum

CUSUM method
create.grid

Computes a matrix of initial values
disProg2sts

Convert disProg object to sts and vice versa
algo.farrington.assign.weights

Assign weights to base counts
loglikelihood

Calculation of the loglikelihood needed in algo.hhh
pit

Non-Randomized Version of the PIT Histogram (for Count Data)
poly2adjmat

Derive Adjacency Structure of "SpatialPolygons"
zetaweights

Power-Law Weights According to Neighbourhood Order
MMRcoverageDE

MMR coverage levels in the 16 states of Germany
stsNC-class

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

The Bayes System
sts-class

Class "sts" -- surveillance time series
algo.quality

Computation of Quality Values for a Surveillance System Result
farringtonFlexible

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

Residuals from a HHH model
unionSpatialPolygons

Compute the Unary Union of "SpatialPolygons"
hhh4_W

Power-Law and Nonparametric Neighbourhood Weights for hhh4-Models
twinstim_iafplot

Plot the spatial or temporal interaction function of a twimstim
estimateGLRPoisHook

Hook function for in-control mean estimation
algo.summary

Summary Table Generation for Several Disease Chains
twinSIR_methods

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

Surgical failures data
algo.glrpois

Poisson regression charts
checkResidualProcess

Check the residual process of a fitted twinSIR or twinstim
algo.rogerson

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

Plot Generation
bestCombination

Partition of a number into two factors
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
plot.hhh4

Plots for Fitted hhh4-models
isScalar

Checks if the Argument is Scalar
epidata_plot

Plotting the Evolution of an Epidemic
backprojNP

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

Generation of Simulated Point Source Epidemy
animate

Generic animation of spatio-temporal 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)
layout.labels

Layout Item for Feature Labels in spplot
toLatex.sts

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

Measles in the 16 states of Germany
toFileDisProg

Writing of Disease Data
twinSIR_profile

Profile Likelihood Computation and Confidence Intervals
enlargeData

Data Enlargement
polyAtBorder

Indicate Polygons at the Border
husO104Hosp

Hospitalization date for HUS cases of the STEC outbreak in Germany, 2011
print.algoQV

Print quality value object
scale.gpc.poly

Centering and Scaling a "gpc.poly" Polygon
twinstim_simulation

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

Update method for "epidataCS"
salmNewport

Salmonella Newport cases in Germany 2004-2013
algo.hmm

Hidden Markov Model (HMM) method
[,sts-methods

Extraction and Subsetting of sts objects
algo.rki

The system used at the RKI
find.kh

Determine the k and h values in a standard normal setting
estimateGLRNbHook

Hook function for in-control mean estimation
runifdisc

Sample Points Uniformly on a Disc
residualsCT

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

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

Find reference value
plot.atwins

Plot results of a twins model fit
sts_animate

Animated Maps and Time Series of Disease Incidence
hhh4

Fitting HHH Models with Random Effects and Neighbourhood Structure
compMatrix.writeTable

Latex Table Generation
momo

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

Rotavirus cases in Brandenburg, Germany, during 2002-2013 stratified by 5 age categories
refvalIdxByDate

Compute indices of reference value using Date class
plot.survRes

Plot a survRes object
nbOrder

Determine Neighbourhood Order Matrix from Binary Adjacency Matrix
glm_epidataCS

Fit an Endemic-Only twinstim as a Poisson-glm
readData

Reading of Disease Data
salmHospitalized

Hospitalized Salmonella cases in Germany 2004-2014
twinstim_methods

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

Simulation of Epidemic Data
twinstim_intensity

Plotting Intensities of Infection over Time or Space
imdepi

Occurrence of Invasive Meningococcal Disease in Germany
magic.dim

Returns a suitable k1 x k2 for plotting the disProgObj
qlomax

Quantile Function of the Lomax Distribution
stsplot_space

Map of Disease Incidence During a Given Period
sim.seasonalNoise

Generation of Background Noise for Simulated Timeseries
surveillance.options

Options of the surveillance Package
twinSIR_cox

Identify Endemic Components in an Intensity Model
twinstim_update

update-method for "twinstim"
untie

Randomly Break Ties in Data
simHHH

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

Print xtable for a Simulated Disease and the Summary
siaf.simulatePC

Simulation from an Isotropic Spatial Kernel via Polar Coordinates
LRCUSUM.runlength

Run length computation of a CUSUM detector
twinstim_step

Stepwise Model Selection by AIC
twinstim

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

Temporal and Spatial Interaction Functions for twinstim
discpoly

Polygonal Approximation of a Disc/Circle
epidata_intersperse

Impute Blocks for Extra Stops in "epidata" Objects
intensityplot

Plot Paths of Point Process Intensities
pairedbinCUSUM

Paired binary CUSUM and its run-length computation
multiplicity

Import from package spatstat
twinstim_plot

Plot methods for fitted twinstim's
stsSlot-generics

Generic functions to access "sts" slots
epidataCS_plot

Plotting the Events of an Epidemic over Time and Space
aggregate-methods

Aggregate the the series of an sts object
abattoir

Abattoir Data
plot.disProg

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

update a fitted "hhh4" model