Calculates the CFR at each time point in the case and death time series supplied, using an expanding window of time. The static CFR is calculated for each time point, using the time series from the start to each time point, and increasing the number of time points included by one in each iteration.
Arguments
- data
A
<data.frame>containing the outbreak data. A daily time series with dates or some other absolute indicator of time (e.g. epiday or epiweek) and the numbers of new cases and new deaths at each time point. Note that the required columns are "date" (for the date), "cases" (for the number of reported cases), and "deaths" (for the number of reported deaths) on each day of the outbreak.Note that the
<data.frame>is required to have an unbroken sequence of dates with no missing dates in between. The "date" column must be of classDate(seeas.Date()).Note also that the total number of cases must be greater than the total number of reported deaths.
- delay_density
An optional argument that controls whether delay correction is applied in the severity estimation. May be
NULL, for no delay correction, or a function that returns the density function of a distribution to evaluate density at user-specified values, e.g.function(x) stats::dgamma(x = x, shape = 5, scale = 1).- poisson_threshold
The case count above which to use Poisson approximation. Set to 100 by default. Must be > 0.
Value
A <data.frame> with the date, maximum likelihood estimate and 95%
confidence interval of the daily severity estimates, named
"severity_mean", "severity_low", and "severity_high", with one row for each
day in the original data.frame.
Details
When delay correction is applied by passing a delay distribution
density function to delay_density, the internal function
.estimate_severity() is used to calculate the rolling severity.
Note that in the naive method the severity estimate and confidence intervals
cannot be calculated for days on which the cumulative number of cases since
the start of the time-series, and for days on which the cumulative number of
deaths reported exceeds the cumulative reported cases, and is returned as
NA.
Examples
# load package data
data("ebola1976")
# estimate severity without correcting for delays
cfr_static(ebola1976)
#> severity_mean severity_low severity_high
#> 1 0.955102 0.9210866 0.9773771
# estimate severity for each day while correcting for delays
# obtain onset-to-death delay distribution parameters from Barry et al. 2018
# The Lancet. <https://doi.org/10.1016/S0140-6736(18)31387-4>
# view only the first values
estimate <- cfr_rolling(
ebola1976,
delay_density = function(x) dgamma(x, shape = 2.40, scale = 3.33)
)
#> `cfr_rolling()` is a convenience function to help understand how additional data influences the overall (static) severity. Use `cfr_time_varying()` instead to estimate severity changes over the course of the outbreak.
#> Some daily ratios of total deaths to total cases with known outcome are below 0.01%: some CFR estimates may be unreliable.FALSE
head(estimate)
#> date severity_mean severity_low severity_high
#> 1 1976-08-25 NA NA NA
#> 2 1976-08-26 1e-04 1e-04 0.9999
#> 3 1976-08-27 1e-04 1e-04 0.9999
#> 4 1976-08-28 1e-04 1e-04 0.9999
#> 5 1976-08-29 1e-04 1e-04 0.9990
#> 6 1976-08-30 1e-04 1e-04 0.9942