Learn R Programming

surveillance (version 1.23.1)

Temporal and Spatio-Temporal Modeling and Monitoring of Epidemic Phenomena

Description

Statistical methods for the modeling and monitoring of time series of counts, proportions and categorical data, as well as for the modeling of continuous-time point processes of epidemic phenomena. The monitoring methods focus on aberration detection in count data time series from public health surveillance of communicable diseases, but applications could just as well originate from environmetrics, reliability engineering, econometrics, or social sciences. The package implements many typical outbreak detection procedures such as the (improved) Farrington algorithm, or the negative binomial GLR-CUSUM method of Hoehle and Paul (2008) . A novel CUSUM approach combining logistic and multinomial logistic modeling is also included. The package contains several real-world data sets, the ability to simulate outbreak data, and to visualize the results of the monitoring in a temporal, spatial or spatio-temporal fashion. A recent overview of the available monitoring procedures is given by Salmon et al. (2016) . For the retrospective analysis of epidemic spread, the package provides three endemic-epidemic modeling frameworks with tools for visualization, likelihood inference, and simulation. hhh4() estimates models for (multivariate) count time series following Paul and Held (2011) and Meyer and Held (2014) . twinSIR() models the susceptible-infectious-recovered (SIR) event history of a fixed population, e.g, epidemics across farms or networks, as a multivariate point process as proposed by Hoehle (2009) . twinstim() estimates self-exciting point process models for a spatio-temporal point pattern of infective events, e.g., time-stamped geo-referenced surveillance data, as proposed by Meyer et al. (2012) . A recent overview of the implemented space-time modeling frameworks for epidemic phenomena is given by Meyer et al. (2017) .

Copy Link

Version

Install

install.packages('surveillance')

Monthly Downloads

2,040

Version

1.23.1

License

GPL-2

Maintainer

Last Published

September 2nd, 2024

Functions in surveillance (1.23.1)

R0

Computes reproduction numbers from fitted models
abattoir

Abattoir Data
algo.bayes

The Bayes System
algo.outbreakP

Semiparametric surveillance of outbreaks
algo.hmm

Hidden Markov Model (HMM) method
algo.glrnb

Count Data Regression Charts
MMRcoverageDE

MMR coverage levels in the 16 states of Germany
algo.quality

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

Comparison of Specified Surveillance Systems using Quality Values
algo.rki

The system used at the RKI
algo.cusum

CUSUM method
arlCusum

Calculation of Average Run Length for discrete CUSUM schemes
anscombe.residuals

Compute Anscombe Residuals
algo.summary

Summary Table Generation for Several Disease Chains
algo.twins

Fit a Two-Component Epidemic Model using MCMC
all.equal

Test if Two Model Fits are (Nearly) Equal
algo.farrington.fitGLM

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

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

Surveillance for Count Time Series Using the Classic Farrington Method
calibrationTest

Calibration Tests for Poisson or Negative Binomial Predictions
campyDE

Campylobacteriosis and Absolute Humidity in Germany 2002-2011
animate

Generic animation of spatio-temporal objects
categoricalCUSUM

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

Creating an object of class disProg (DEPRECATED)
algo.farrington.assign.weights

Assign weights to base counts
algo.farrington.threshold

Compute prediction interval for a new observation
checkResidualProcess

Check the residual process of a fitted twinSIR or twinstim
deleval

Surgical Failures Data
epidataCS_animate

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

Convert disProg object to sts and vice versa
earsC

Surveillance for a count data time series using the EARS C1, C2 or C3 method and its extensions
discpoly

Polygonal Approximation of a Disc/Circle
epidataCS_permute

Randomly Permute Time Points or Locations of "epidataCS"
backprojNP

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

Partition of a number into two factors
bodaDelay

Bayesian Outbreak Detection in the Presence of Reporting Delays
boda

Bayesian Outbreak Detection Algorithm (BODA)
clapply

Conditional lapply
coeflist

List Coefficients by Model Component
epidata

Continuous-Time SIR Event History of a Fixed Population
ha

Hepatitis A in Berlin
epidata_animate

Spatio-Temporal Animation of an Epidemic
hagelloch

1861 Measles Epidemic in the City of Hagelloch, Germany
epidata_intersperse

Impute Blocks for Extra Stops in "epidata" Objects
hhh4_simulate_scores

Proper Scoring Rules for Simulations from hhh4 Models
epidataCS

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

Internal Functions Dealing with hhh4 Models
epidataCS_plot

Plotting the Events of an Epidemic over Time and Space
hhh4_update

update a fitted "hhh4" model
influMen

Influenza and meningococcal infections in Germany, 2001-2006
epidataCS_aggregate

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

Update method for "epidataCS"
hhh4_methods

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

Plot Paths of Point Process Intensities
m1

RKI SurvStat Data
findH

Find decision interval for given in-control ARL and reference value
magic.dim

Compute Suitable k1 x k2 Layout for Plotting
estimateGLRNbHook

Hook function for in-control mean estimation
formatPval

Pretty p-Value Formatting
fanplot

Fan Plot of Forecast Distributions
intersectPolyCircle

Intersection of a Polygonal and a Circular Domain
epidata_plot

Plotting the Evolution of an Epidemic
glm_epidataCS

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

Find ISO Week and Year of Date Objects
plot.atwins

Plots for Fitted algo.twins Models
epidata_summary

Summarizing an Epidemic
measles.weser

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

Find Reference Value
plot.disProg

Plot Observed Counts and Defined Outbreak States of a (Multivariate) Time Series
measlesDE

Measles in the 16 states of Germany
farringtonFlexible

Surveillance for Univariate Count Time Series Using an Improved Farrington Method
hhh4_simulate

Simulate "hhh4" Count Time Series
hhh4_simulate_plot

Plot Simulations from "hhh4" Models
multiplicity

Import from package spatstat.geom
multiplicity.Spatial

Count Number of Instances of Points
makeControl

Generate control Settings for an hhh4 Model
polyAtBorder

Indicate Polygons at the Border
find.kh

Determine the k and h values in a standard normal setting
hcl.colors

HCL-based Heat Colors from the colorspace Package
fluBYBW

Influenza in Southern Germany
hepatitisA

Hepatitis A in Germany
imdepi

Occurrence of Invasive Meningococcal Disease in Germany
marks

Import from package spatstat.geom
formatDate

Convert Dates to Character (Including Quarter Strings)
imdepifit

Example twinstim Fit for the imdepi Data
hhh4_plot

Plots for Fitted hhh4-models
nbOrder

Determine Neighbourhood Order Matrix from Binary Adjacency Matrix
nowcast

Adjust a univariate time series of counts for observed but-not-yet-reported events
print.algoQV

Print Quality Value Object
layout.labels

Layout Items for spplot
linelist2sts

Convert Dates of Individual Case Reports into a Time Series of Counts
hhh4_predict

Predictions from a hhh4 Model
ranef

Import from package nlme
primeFactors

Prime Number Factorization
rotaBB

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

Salmonella cases in Germany 2001-2014 by data of symptoms onset
salmHospitalized

Hospitalized Salmonella cases in Germany 2004-2014
knox

Knox Test for Space-Time Interaction
ks.plot.unif

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

Sample Points Uniformly on a Disc
stsNClist_animate

Animate a Sequence of Nowcasts
twinstim

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

Paired binary CUSUM and its run-length computation
stsNewport

Salmonella Newport cases in Germany 2001-2015
permutationTest

Monte Carlo Permutation Test for Paired Individual Scores
sim.pointSource

Simulate Point-Source Epidemics
twinstim_epitest

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

Temporal and Spatial Interaction Functions for twinstim
salmNewport

Salmonella Newport cases in Germany 2004-2013
hhh4

Fitting HHH Models with Random Effects and Neighbourhood Structure
twinstim_iafplot

Plot the Spatial or Temporal Interaction Function of a twimstim
refvalIdxByDate

Compute indices of reference value using Date class
hhh4_W

Power-Law and Nonparametric Neighbourhood Weights for hhh4-Models
sim.seasonalNoise

Generation of Background Noise for Simulated Timeseries
salmonella.agona

Salmonella Agona cases in the UK 1990-1995
residualsCT

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

update-method for "twinstim"
scores

Proper Scoring Rules for Poisson or Negative Binomial Predictions
stsplot_time

Time-Series Plots for "sts" Objects
unionSpatialPolygons

Compute the Unary Union of "SpatialPolygons"
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
hhh4_W_utils

Extract Neighbourhood Weights from a Fitted hhh4 Model
sts-class

Class "sts" -- surveillance time series
surveillance-defunct

Defunct Functions in Package surveillance
aggregate-methods

Aggregate an "sts" Object Over Time or Across Units
stsplot_space

Map of Disease Counts/Incidence accumulated over a Given Period
stsSlot-generics

Generic Functions to Access "sts" Slots
hhh4_formula

Specify Formulae in a Random Effects HHH Model
twinSIR_profile

Profile Likelihood Computation and Confidence Intervals
twinSIR_intensityplot

Plotting Paths of Infection Intensities for twinSIR Models
stsplot_spacetime

Animated Map of Disease Incidence (DEPRECATED)
hhh4_validation

Predictive Model Assessment for hhh4 Models
stsNC-class

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

Time-Series Plots for "sts" Objects Using ggplot2
husO104Hosp

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

Simulation of Epidemic Data
meningo.age

Meningococcal infections in France 1985-1997
stsXtrct

Subsetting "sts" Objects
momo

Danish 1994-2008 all-cause mortality data for eight age groups
pit

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

Verbose and Parallel lapply
tidy.sts

Convert an "sts" Object to a Data Frame in Long (Tidy) Format
sts_observation

Create an sts object with a given observation date
twinSIR_methods

Print, Summary and Extraction Methods for "twinSIR" Objects
plot.survRes

Plot a survRes object
poly2adjmat

Derive Adjacency Structure of "SpatialPolygons"
stsplot

Plot Methods for Surveillance Time-Series Objects
twinSIR_cox

Identify Endemic Components in an Intensity Model
twinSIR_exData

Toy Data for twinSIR
stK

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

Spatio-temporal cluster detection
toLatex.sts

toLatex-Method for "sts" Objects
twinstim_simEndemicEvents

Quick Simulation from an Endemic-Only twinstim
twinSIR

Fit an Additive-Multiplicative Intensity Model for SIR Data
sts_animate

Animated Maps and Time Series of Disease Counts or Incidence
sts_creation

Simulate Count Time Series with Outbreaks
twinstim_siaf

Spatial Interaction Function Objects
twinstim_intensity

Plotting Intensities of Infection over Time or Space
surveillance-package

surveillance: tools:::Rd_package_title("surveillance")
twinstim_simulation

Simulation of a Self-Exciting Spatio-Temporal Point Process
siaf.simulatePC

Simulation from an Isotropic Spatial Kernel via Polar Coordinates
zetaweights

Power-Law Weights According to Neighbourhood Order
twinstim_plot

Plot methods for fitted twinstim's
surveillance.options

Options of the surveillance Package
twinstim_methods

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

Profile Likelihood Computation and Confidence Intervals for twinstim objects
twinstim_step

Stepwise Model Selection by AIC
untie

Randomly Break Ties in Data
wrap.algo

Multivariate Surveillance through independent univariate algorithms
twinstim_tiaf

Temporal Interaction Function Objects
algo.call

Query Transmission to Specified Surveillance Algorithm
addSeason2formula

Add Harmonics to an Existing Formula
aggregate.disProg

Aggregate a disProg Object
LRCUSUM.runlength

Run length computation of a CUSUM detector
addFormattedXAxis

Formatted Time Axis for "sts" Objects
algo.cdc

The CDC Algorithm