nimue_format: Nimue format that returns just compartments/summaries...

View source: R/nimue_utils.R

nimue_formatR Documentation

Nimue format that returns just compartments/summaries requested

Description

Nimue format that returns just compartments/summaries requested

Usage

nimue_format(
  out,
  var_select = NULL,
  reduce_age = TRUE,
  combine_compartments = TRUE,
  date_0 = NULL
)

Arguments

out

nimue_simulation object

var_select

Vector of compartment names, e.g. c("S", "R"). In addition a number of summary compartment can be requested. These include:

  • "deaths" Daily Deaths

  • "infections" Daily Infections

  • "hospital_occupancy" Occupied Hospital Beds

  • "ICU_occupancy" Occupied ICU Beds

  • "hospital_demand" Required Hospital Beds

  • "ICU_demand" Required ICU Beds

  • "hospital_incidence" Incidence of hospitilisation

  • "ICU_incidence" Incidence of ICU admissions

  • "hospitilisations" Incidence of hospital+ICU admissions

  • ""vaccines", "unvaccinated", "vaccinated", "priorvaccinated" Vaccine outputs

reduce_age

Collapse age-dimension, calculating the total in the compartment.

combine_compartments

Collapse compartments of same type together (e.g. E1 and E2 -> E)

date_0

Date of time 0, if specified a date column will be added

Value

Formatted long data.frame


OJWatson/iran-ascertainment documentation built on April 24, 2022, 10:09 p.m.