Skip to contents

Print a summary of an infectivity profile

Source: R/infectivity-profile.R
format_ip.Rd

Print a summary of an infectivity profile

Usage

format_ip(ip = i_empirical_ip)

Arguments

ip

the infectivity profile to summarise. a0 and a1 columns are optional if tau is given.

A dataframe containing the following columns:

  • boot (anything + default(1)) - a bootstrap identifier

  • probability (proportion) - the probability of new event during this period.

  • a0 (double) - the beginning of the time period (in days)

  • a1 (double) - the end of the time period (in days)

Must be grouped by: boot (exactly).

A default value is defined.

Value

an infectivity profile description

Examples

format_ip(ganyani_ip)
#> [1] "PDF: mean: 5.25 [3.74 — 6.65]; sd: 1.92 [0.705 — 3.19]; 100 bootstraps"