getDeaths.SEIRModel: Get deaths

View source: R/getDeaths.R

getDeaths.SEIRModelR Documentation

Get deaths

Description

Gets the total deaths from the given model

Usage

## S3 method for class 'SEIRModel'
getDeaths(model, byGroup = TRUE, asRate = FALSE,
  fractionSymptomatic, caseFatalityRatio)

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

fractionSymptomatic

The fraction of cases that are symptomatic; single fraction or vector of fractions by population group; must be specified

caseFatalityRatio

The fraction of cases that result in fatalities; single fraction or vector of fractions by population group; must be specified

Value

A vector of deaths or death rates


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