stsSD {EpiSignalDetection}R Documentation

Build sts object

Description

Build sts surveillance object

Usage

stsSD(observedCases, studyPeriod, timeUnit = "Month", startYM = c(2000, 1) )

Arguments

observedCases

numeric vector of the number of cases by time unit (y axis of the time series)

studyPeriod

vector of dates of length(obeservedCases) (x axis of the time series)

timeUnit

character string for the time unit of the time series. Options are Week or Month.

startYM

numeric vector including Year and Month of start of the historical data

Value

sts

See Also

aggAtlasExport algoSD

Examples

#-- Setting the parameters to run the report for
input <- list(
disease = "Salmonellosis",
country = "EU-EEA - complete series",
indicator = "Reported cases",
stratification = "Confirmed cases",
unit = "Month",
daterange = c("2010-01-01", "2016-12-31"),
algo = "FarringtonFlexible",
testingperiod = 5
)

#-- Example dataset
dataset <- EpiSignalDetection::SignalData

#-- Filtering on declared input parameters
dataset <- filterAtlasExport(dataset, input)

#-- Aggregating the data by geographical level and time point
dataset <- aggAtlasExport(dataset, input)

#-- Bulding the corresponding sts object
dataset.sts <- stsSD(observedCases = dataset$NumValue,
                     studyPeriod = dataset$StudyPeriod,
                     timeUnit = input$unit,
                     startYM = c(as.numeric(format(as.Date(input$daterange[1], "%Y-%m-%d"), "%Y")),
                                 as.numeric(format(as.Date(input$daterange[1], "%Y-%m-%d"), "%m"))))


[Package EpiSignalDetection version 0.1.2 Index]