getHospitalizations.SEIRModel: Get hospitalizations

View source: R/getHospitalizations.R

getHospitalizations.SEIRModelR Documentation

Get hospitalizations

Description

Gets the total hospitalizations from the given model

Usage

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

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

caseHospitalizationRatio

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

Value

A vector of hospitalizations or hospitalization rates


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