get_official_observed_seasonal_quantities: Compute season onset, peak week, and peak incidence

Description Usage Arguments Value

View source: R/utils.R

Description

Compute season onset, peak week, and peak incidence

Usage

1

Arguments

data

a data frame containing at minimum columns named season, season_week and a column with some sort of incidence measure

season

the season to look at

incidence_var

a character string naming the variable in the data argument containing a measure of incidence, or an integer index

Value

a list with four entries: 1) observed_onset_week, either an integer between first_CDC_season_week and last_CDC_season_week (inclusive), or "none" 2) observed_peak_week, an integer between first_CDC_season_week and last_CDC_season_week (inclusive) 3) observed_peak_inc, a numeric with the maximum value of the specified incidence measure between first_CDC_season_week and last_CDC_season_week 4) observed_peak_inc_bin, character name of incidence bin for peak incidence


reichlab/2017-2018-cdc-flu-contest documentation built on May 24, 2019, 6:17 a.m.