Description Usage Arguments Value
View source: R/forecasting_main.R
Runs the forecast modeling
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | run_forecast(
epi_data,
quo_popfield,
quo_groupfield,
env_data,
quo_obsfield,
quo_valuefield,
env_ref_data,
env_info,
fc_model_family,
report_settings,
valid_run,
groupings,
env_variables,
report_dates
)
|
epi_data |
Epidemiological data with case numbers per week, with date field "obs_date". |
quo_popfield |
Quosure of user-given field containing population values. |
quo_groupfield |
Quosure of the user given geographic grouping field to run_epidemia(). |
env_data |
Daily environmental data for the same groupfields and date
range as the epidemiological data. It may contain extra data (other
districts or date ranges). The data must be in long format (one row for each
date and environmental variable combination), and must start at absolutel
minimum |
quo_obsfield |
Quosure of user given field name of the environmental data variables. |
quo_valuefield |
Quosure of user given field name of the value of the environmental data variable observations. |
env_ref_data |
Historical averages by week of year for environmental variables. Used in extended environmental data into the future for long forecast time, to calculate anomalies in early detection period, and to display on timeseries in reports. |
env_info |
Lookup table for environmental data - reference creation method (e.g. sum or mean), report labels, etc. |
fc_model_family |
The |
report_settings |
This is a named list of all the report, forecasting, event detection and other settings. All of these have defaults, but they are not likely the defaults needed for your system, so each of these should be reviewed:
|
valid_run |
Internal TRUE/FALSE for whether this is part of a validation run. |
groupings |
A unique list of the geographic groupings (from groupfield). |
env_variables |
List of environmental variables that exist in env_data. |
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. |
Named list containing: fc_epi: Full forecasted resulting dataset. fc_res: The forecasted series in report format. env_data_extd: Data set of the environmental data variables extended into the unknown/future. env_variables_used: list of environmental variables that were used in the modeling (had to be listed in model variables input file and present the env_data and env_info datasets) env_dt_ranges: Date ranges of the input environmental data. reg_obj: The regression object from modeling. Unless model_run is TRUE, in which case only the regression object is returned.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.