Prep Data for seasonal heatmap
iidda_prep_seasonal_heatmap.RdPrep data for seasonal heatmap plots. Prep steps were taken from LBoM::seasonal_heat_map
and they include creating additional time unit fields, splitting weeks that cover the
year end, and optionally normalizing series data to be in the range (0,1).
Usage
iidda_prep_seasonal_heatmap(
data,
series_variable = NULL,
start_time_variable = "period_start_date",
end_time_variable = "period_end_date",
time_unit = c("yday", "year"),
prepend_string = "End ",
normalize = FALSE,
...
)Arguments
- data
data frame containing time series data
- series_variable
column name of series variable in
data, default is "deaths"- start_time_variable
column name of time variable in
data, default is "period_start_date"- end_time_variable
column name of time variable in
data, default is "period_end_date"- time_unit
a vector of new time unit fields to create from
start_time_variableandend_time_variable. Defaults to "c("yday","year")". The currently functionality expects that both "yday" and "year" are included, should be made more general to incorporate any of iidda.analysis:::time_units.- prepend_string
string to prepend to newly created time_unit fields to distinguish between time_unit fields corresponding to starting versus ending time periods. Defaults to "End ". For example, a
time_unitof "year" will create a field name "Year" fromstart_time_variableand a field called "End Year" created fromend_time_variable.- normalize
boolean flag to normalize
series_variabledata to be between 0 and 1.- ...
optional arguments to
year_end_fix()