getInfectionTimeSeries.SEIRModel: Get infection time series

View source: R/getInfectionTimeSeries.R

getInfectionTimeSeries.SEIRModelR Documentation

Get infection time series

Description

Gets the time series of infections from the given model

Usage

## S3 method for class 'SEIRModel'
getInfectionTimeSeries(model, byGroup = TRUE,
  asRate = FALSE, incidence = FALSE, symptomatic = FALSE,
  fractionSymptomatic, byWeek = FALSE)

Arguments

model

The model from which to get the data

byGroup

Whether or not to return data by population group; defaults to TRUE

asRate

Whether to return results as a rate (fraction of population) or else a number; defaults to FALSE

incidence

If true, returns infection incidence, otherwise returns infection prevalence; defaults to FALSE

symptomatic

Whether or not to only report symptomatic infections; defaults to FALSE

fractionSymptomatic

The fraction of cases that are symptomatic; must be specified if symptomatic = TRUE

byWeek

If true, returns the output on a weekly, not daily basis; defaults to FALSE

Value

A matrix that contains the infections by simulation day (or week, if byWeek is selected)


HHS/ASPR-flumodels documentation built on Dec. 6, 2022, 12:20 p.m.