Description Usage Arguments Value
View source: R/event_detection.R
Main subfunction for running event detection algorithm.
1 2 3 4 5 6 7 8 9 10 11 12 | run_event_detection(
epi_fc_data,
quo_groupfield,
quo_popfield,
ed_method,
ed_control,
val_type,
inc_per,
groupings,
report_dates,
valid_run
)
|
epi_fc_data |
Internal pass of epidemiological data complete with future forecast values. |
quo_groupfield |
Quosure of the user given geographic grouping field to run_epidemia(). |
quo_popfield |
Quosure of user-given field containing population values. |
ed_method |
An extract of report_settings$ed_method after defaults have been applied - which method for early detection should be used ("farrington" or default "none", currently). |
ed_control |
An extract of report_settings$ed_control - all parameters for early detection algorithm, passed through to that subroutine. |
val_type |
An extract of report_settings$report_value_type after defaults applies - whether to return epidemiological report values in "incidence" or "cases" (default). |
inc_per |
An extract of report_settings$report_inc_per after defaults applies - number for what unit of population the incidence should be reported in, e.g. incidence rate per 1000 people. Ignored when report_settings$report_value_type is 'cases'. |
groupings |
A unique list of the geographic groupings (from groupfield). |
report_dates |
Internally generated set of report date information: min, max, list of dates for full report, known epidemiological data period, forecast period, and early detection period. |
valid_run |
Internal TRUE/FALSE for whether this is part of a validation run. |
Returns a list of three generated series: "ed" : early detection alerts (ed period of most recent epi data) "ew" : early warning alerts (forecast/future portion) "thresh" : threshold values per week
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.