"utils/epiweek" | flusight-csv-tools

Epiweek and time related functions

Index

Functions

Functions

currentEpiweek

currentEpiweek(): Epiweek

- Defined in utils/epiweek.ts:45
Return current epiweek

Returns Epiweek

currentSeasonId

currentSeasonId(): SeasonId

- Defined in utils/epiweek.ts:86
Return id for current season

Returns SeasonId

epiweekWithDiff

epiweekWithDiff(epiweek: Epiweek, diff: number): Epiweek

- Defined in utils/epiweek.ts:63
Return epiweek with diff number of weeks added

Parameters
- epiweek: Epiweek
- diff: number
Returns Epiweek

getEpiweekDiff

getEpiweekDiff(first: Epiweek, second: Epiweek): number

- Defined in utils/epiweek.ts:73
Return equivalent of first - second in epiweek scale

Parameters
- first: Epiweek
- second: Epiweek
Returns number

seasonEpiweeks

seasonEpiweeks(season: SeasonId): Epiweek[]

- Defined in utils/epiweek.ts:93
Return a list of epiweeks in the season provided

Parameters
- season: SeasonId
Returns Epiweek[]

seasonFromEpiweek

seasonFromEpiweek(epiweek: Epiweek): SeasonId

- Defined in utils/epiweek.ts:55
Return seasons for given epiweek. Assume seasons start from mmwr-week 30 and end on next year's week 29

Parameters
- epiweek: Epiweek
Returns SeasonId

weekToEpiweek

weekToEpiweek(week: number, seasonId: SeasonId): Epiweek

- Defined in utils/epiweek.ts:15
Convert given week and season to epiweek, handle non standard values too

Parameters
- week: number
- seasonId: SeasonId
Returns Epiweek

Generated using TypeDoc