Learn R Programming

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

surveillance (version 1.23.0)

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,035

Version

1.23.0

License

GPL-2

Maintainer

Last Published

May 4th, 2024

Functions in surveillance (1.23.0)

MMRcoverageDE

MMR coverage levels in the 16 states of Germany
addSeason2formula

Add Harmonics to an Existing Formula
addFormattedXAxis

Formatted Time Axis for "sts" Objects
algo.farrington.threshold

Compute prediction interval for a new observation
algo.farrington.fitGLM

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

CUSUM method
algo.glrnb

Count Data Regression Charts
algo.compare

Comparison of Specified Surveillance Systems using Quality Values
algo.outbreakP

Semiparametric surveillance of outbreaks
algo.hmm

Hidden Markov Model (HMM) method
algo.farrington.assign.weights

Assign weights to base counts
algo.farrington

Surveillance for Count Time Series Using the Classic Farrington Method
algo.quality

Computation of Quality Values for a Surveillance System Result
all.equal

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

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

The system used at the RKI
anscombe.residuals

Compute Anscombe Residuals
animate

Generic animation of spatio-temporal objects
arlCusum

Calculation of Average Run Length for discrete CUSUM schemes
categoricalCUSUM

CUSUM detector for time-varying categorical time series
checkResidualProcess

Check the residual process of a fitted twinSIR or twinstim
campyDE

Campylobacteriosis and Absolute Humidity in Germany 2002-2011
calibrationTest

Calibration Tests for Poisson or Negative Binomial Predictions
algo.summary

Summary Table Generation for Several Disease Chains
bodaDelay

Bayesian Outbreak Detection in the Presence of Reporting Delays
bestCombination

Partition of a number into two factors
backprojNP

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

Fit a Two-Component Epidemic Model using MCMC
boda

Bayesian Outbreak Detection Algorithm (BODA)
deleval

Surgical Failures Data
create.disProg

Creating an object of class disProg (DEPRECATED)
disProg2sts

Convert disProg object to sts and vice versa
epidata

Continuous-Time SIR Event History of a Fixed Population
earsC

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

Conditional lapply
discpoly

Polygonal Approximation of a Disc/Circle
epidataCS_plot

Plotting the Events of an Epidemic over Time and Space
epidataCS_update

Update method for "epidataCS"
epidataCS_aggregate

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

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

List Coefficients by Model Component
epidataCS_permute

Randomly Permute Time Points or Locations of "epidataCS"
epidataCS_animate

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

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

Find Reference Value
epidata_animate

Spatio-Temporal Animation of an Epidemic
epidata_intersperse

Impute Blocks for Extra Stops in "epidata" Objects
find.kh

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

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

Hook function for in-control mean estimation
epidata_summary

Summarizing an Epidemic
fanplot

Fan Plot of Forecast Distributions
epidata_plot

Plotting the Evolution of an Epidemic
hhh4_W

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

Hepatitis A in Berlin
fluBYBW

Influenza in Southern Germany
formatPval

Pretty p-Value Formatting
hagelloch

1861 Measles Epidemic in the City of Hagelloch, Germany
glm_epidataCS

Fit an Endemic-Only twinstim as a Poisson-glm
hcl.colors

HCL-based Heat Colors from the colorspace Package
hhh4

Fitting HHH Models with Random Effects and Neighbourhood Structure
formatDate

Convert Dates to Character (Including Quarter Strings)
hepatitisA

Hepatitis A in Germany
hhh4_simulate_scores

Proper Scoring Rules for Simulations from hhh4 Models
hhh4_W_utils

Extract Neighbourhood Weights from a Fitted hhh4 Model
hhh4_simulate

Simulate "hhh4" Count Time Series
hhh4_simulate_plot

Plot Simulations from "hhh4" Models
hhh4_formula

Specify Formulae in a Random Effects HHH Model
hhh4_update

update a fitted "hhh4" model
hhh4_plot

Plots for Fitted hhh4-models
hhh4_predict

Predictions from a hhh4 Model
hhh4_internals

Internal Functions Dealing with hhh4 Models
hhh4_methods

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

Influenza and meningococcal infections in Germany, 2001-2006
imdepi

Occurrence of Invasive Meningococcal Disease in Germany
husO104Hosp

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

Find ISO Week and Year of Date Objects
imdepifit

Example twinstim Fit for the imdepi Data
intensityplot

Plot Paths of Point Process Intensities
hhh4_validation

Predictive Model Assessment for hhh4 Models
knox

Knox Test for Space-Time Interaction
isScalar

Checks if the Argument is Scalar
intersectPolyCircle

Intersection of a Polygonal and a Circular Domain
marks

Import from package spatstat.geom
measles.weser

Measles in the Weser-Ems region of Lower Saxony, Germany, 2001-2002
ks.plot.unif

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

Generate control Settings for an hhh4 Model
layout.labels

Layout Items for spplot
magic.dim

Compute Suitable k1 x k2 Layout for Plotting
meningo.age

Meningococcal infections in France 1985-1997
measlesDE

Measles in the 16 states of Germany
m1

RKI SurvStat Data
linelist2sts

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

Import from package spatstat.geom
permutationTest

Monte Carlo Permutation Test for Paired Individual Scores
momo

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

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

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

Paired binary CUSUM and its run-length computation
nbOrder

Determine Neighbourhood Order Matrix from Binary Adjacency Matrix
multiplicity.Spatial

Count Number of Instances of Points
plot.atwins

Plots for Fitted algo.twins Models
polyAtBorder

Indicate Polygons at the Border
poly2adjmat

Derive Adjacency Structure of "SpatialPolygons"
plapply

Verbose and Parallel lapply
ranef

Import from package nlme
plot.disProg

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

Compute indices of reference value using Date class
shadar

Salmonella Hadar cases in Germany 2001-2006
plot.survRes

Plot a survRes object
sim.pointSource

Simulate Point-Source Epidemics
scores

Proper Scoring Rules for Poisson or Negative Binomial Predictions
salmonella.agona

Salmonella Agona cases in the UK 1990-1995
sim.seasonalNoise

Generation of Background Noise for Simulated Timeseries
stK

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

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

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

Hospitalized Salmonella cases in Germany 2004-2014
salmNewport

Salmonella Newport cases in Germany 2004-2013
stsXtrct

Subsetting "sts" Objects
primeFactors

Prime Number Factorization
print.algoQV

Print Quality Value Object
sts_animate

Animated Maps and Time Series of Disease Counts or Incidence
salmAllOnset

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

Sample Points Uniformly on a Disc
stsNewport

Salmonella Newport cases in Germany 2001-2015
stsNC-class

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

Generic Functions to Access "sts" Slots
stsNClist_animate

Animate a Sequence of Nowcasts
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
aggregate-methods

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

Spatio-temporal cluster detection
sts_creation

Simulate Count Time Series with Outbreaks
sts-class

Class "sts" -- surveillance time series
sts_observation

Create an sts object with a given observation date
sts_ggplot

Time-Series Plots for "sts" Objects Using ggplot2
surveillance-package

surveillance: tools:::Rd_package_title("surveillance")
surveillance-defunct

Defunct Functions in Package surveillance
stsplot

Plot Methods for Surveillance Time-Series Objects
tidy.sts

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

Map of Disease Counts/Incidence accumulated over a Given Period
stsplot_spacetime

Animated Map of Disease Incidence (DEPRECATED)
stsplot_time

Time-Series Plots for "sts" Objects
twinstim

Fit a Two-Component Spatio-Temporal Point Process Model
surveillance.options

Options of the surveillance Package
twinSIR_simulation

Simulation of Epidemic Data
twinSIR_profile

Profile Likelihood Computation and Confidence Intervals
twinSIR_methods

Print, Summary and Extraction Methods for "twinSIR" Objects
toLatex.sts

toLatex-Method for "sts" Objects
twinSIR_exData

Toy Data for twinSIR
twinSIR_intensityplot

Plotting Paths of Infection Intensities for twinSIR Models
twinSIR_cox

Identify Endemic Components in an Intensity Model
twinSIR

Fit an Additive-Multiplicative Intensity Model for SIR Data
twinstim_methods

Print, Summary and Extraction Methods for "twinstim" Objects
siaf.simulatePC

Simulation from an Isotropic Spatial Kernel via Polar Coordinates
twinstim_epitest

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

Plot methods for fitted twinstim's
twinstim_profile

Profile Likelihood Computation and Confidence Intervals for twinstim objects
twinstim_siaf

Spatial Interaction Function Objects
twinstim_iafplot

Plot the Spatial or Temporal Interaction Function of a twimstim
twinstim_iaf

Temporal and Spatial Interaction Functions for twinstim
twinstim_simEndemicEvents

Quick Simulation from an Endemic-Only twinstim
unionSpatialPolygons

Compute the Unary Union of "SpatialPolygons"
wrap.algo

Multivariate Surveillance through independent univariate algorithms
untie

Randomly Break Ties in Data
twinstim_intensity

Plotting Intensities of Infection over Time or Space
twinstim_simulation

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

Temporal Interaction Function Objects
twinstim_step

Stepwise Model Selection by AIC
zetaweights

Power-Law Weights According to Neighbourhood Order
twinstim_update

update-method for "twinstim"
algo.call

Query Transmission to Specified Surveillance Algorithm
algo.cdc

The CDC Algorithm
LRCUSUM.runlength

Run length computation of a CUSUM detector
aggregate.disProg

Aggregate a disProg Object
R0

Computes reproduction numbers from fitted models
algo.bayes

The Bayes System
abattoir

Abattoir Data