# Getting started with EpiNow2

## Quick start

In the following section we give an overview of the simple use case for `epinow()` and `regional_epinow()`.

The first step to using the package is to load it as follows.

    library(EpiNow2)

### Reporting delays, incubation period and generation time

Distributions can be supplied in two ways. First, one can supply delay data to `estimate_delay()`, where a subsampled bootstrapped lognormal will be fit to account for uncertainty in the observed data without being biased by changes in incidence (see `?EpiNow2::estimate_delay()`).

Second, one can specify predetermined delays with uncertainty using the distribution functions such as `Gamma` or `Lognormal`. An arbitrary number of delay distributions are supported in `dist_spec()` with a common use case being an incubation period followed by a reporting delay. For more information on specifying distributions see (see `?EpiNow2::Distributions`).

For example if data on the delay between onset and infection was available we could fit a distribution to it, using `estimate_delay()`, with appropriate uncertainty as follows (note this is a synthetic example),

    reporting_delay <- estimate_delay(
      rlnorm(1000, log(2), 1),
      max_value = 14, bootstraps = 1
    )

If data was not available we could instead specify an informed estimate of the likely delay using the distribution functions `Gamma` or `LogNormal`. To demonstrate, we choose a lognormal distribution with mean 2, standard deviation 1 and a maximum of 10. This is just an example and unlikely to apply in any particular use case.

    reporting_delay <- LogNormal(mean = 2, sd = 1, max = 10)
    reporting_delay
    #> - lognormal distribution (max: 10):
    #>   meanlog:
    #>     0.58
    #>   sdlog:
    #>     0.47

For the rest of this vignette, we will use inbuilt example literature estimates for the incubation period and generation time of Covid-19 (see here for the code that generates these estimates). These distributions are unlikely to be applicable for your use case. We strongly recommend investigating what might be the best distributions to use in any given use case.

    example_generation_time
    #> - gamma distribution (max: 14):
    #>   shape:
    #>     - normal distribution:
    #>       mean:
    #>         1.4
    #>       sd:
    #>         0.48
    #>   rate:
    #>     - normal distribution:
    #>       mean:
    #>         0.38
    #>       sd:
    #>         0.25
    example_incubation_period
    #> - lognormal distribution (max: 14):
    #>   meanlog:
    #>     - normal distribution:
    #>       mean:
    #>         1.6
    #>       sd:
    #>         0.064
    #>   sdlog:
    #>     - normal distribution:
    #>       mean:
    #>         0.42
    #>       sd:
    #>         0.069

Users can also pass a non-parametric delay distribution vector using the `NonParametric` option for both the generation interval and reporting delays. It is important to note that if doing so, both delay distributions are 0-indexed, meaning the first element corresponds to the probability mass at day 0 of an individual’s infection. Because the discretised renewal equation doesn’t support mass on day 0, the generation interval should be passed in as a 0-indexed vector with a mass of zero on day 0.

    example_non_parametric_gi <-  NonParametric(pmf = c(0, 0.3, 0.5, 0.2))

    example_non_parametric_delay <- NonParametric(pmf = c(0.01, 0.1, 0.5, 0.3, 0.09))

These distributions are passed to downstream functions in the same way that the parametric distributions are.

Now, to the functions.

### epinow()

This function represents the core functionality of the package and includes results reporting, plotting, and optional saving. It requires a data frame of cases by date of report and the distributions defined above.

Load example case data from `{EpiNow2}`.

    reported_cases <- example_confirmed[1:60]
    head(reported_cases)
    #>          date confirm
    #>        <Date>   <num>
    #> 1: 2020-02-22      14
    #> 2: 2020-02-23      62
    #> 3: 2020-02-24      53
    #> 4: 2020-02-25      97
    #> 5: 2020-02-26      93
    #> 6: 2020-02-27      78

Estimate cases by date of infection, the time-varying reproduction number, the rate of growth, and forecast these estimates into the future by 7 days. Summarise the posterior and return a summary table and plots for reporting purposes. If a `target_folder` is supplied results can be internally saved (with the option to also turn off explicit returning of results). Here we use the default model parameterisation that prioritises real-time performance over run-time or other considerations. For other formulations see the documentation for `estimate_infections()`.

    estimates <- epinow(
      data = reported_cases,
      generation_time = gt_opts(example_generation_time),
      delays = delay_opts(example_incubation_period + reporting_delay),
      rt = rt_opts(prior = LogNormal(mean = 2, sd = 0.2)),
      stan = stan_opts(cores = 4),
      verbose = interactive()
    )
    names(estimates)
    #> [1] "estimates"                "estimated_reported_cases"
    #> [3] "summary"                  "plots"
    #> [5] "timing"

Both summary measures and posterior samples are returned for all parameters in an easily explored format which can be accessed using `summary`. The default is to return a summary table of estimates for key parameters at the latest date partially supported by data.

    knitr::kable(summary(estimates))

measure | estimate
--- | ---
New infections per day | 2246 (1345 – 3712)
Expected change in reports | Likely decreasing
Effective reproduction no. | 0.9 (0.71 – 1.1)
Rate of growth | -0.028 (-0.097 – 0.037)
Doubling/halving time (days) | -25 (19 – -7.1)

Summarised parameter estimates can also easily be returned, either filtered for a single parameter or for all parameters.

    head(summary(estimates, type = "parameters", params = "R"))
    #>          date variable  strat     type   median     mean         sd lower_90
    #>        <Date>   <char> <char>   <char>    <num>    <num>      <num>    <num>
    #> 1: 2020-02-22        R   <NA> estimate 2.192146 2.198985 0.11444472 2.024200
    #> 2: 2020-02-23        R   <NA> estimate 2.155321 2.161326 0.10485587 2.002736
    #> 3: 2020-02-24        R   <NA> estimate 2.116282 2.122057 0.09752376 1.973624
    #> 4: 2020-02-25        R   <NA> estimate 2.076851 2.081412 0.09208487 1.944169
    #> 5: 2020-02-26        R   <NA> estimate 2.034924 2.039632 0.08807288 1.907857
    #> 6: 2020-02-27        R   <NA> estimate 1.991849 1.996950 0.08500839 1.867559
    #>    lower_50 lower_20 upper_20 upper_50 upper_90
    #>       <num>    <num>    <num>    <num>    <num>
    #> 1: 2.117945 2.163831 2.223016 2.273580 2.398886
    #> 2: 2.086968 2.130249 2.182448 2.231471 2.342141
    #> 3: 2.053489 2.091872 2.140538 2.184986 2.295274
    #> 4: 2.015866 2.053039 2.099319 2.140357 2.242094
    #> 5: 1.976725 2.012561 2.056509 2.095363 2.195281
    #> 6: 1.936513 1.970944 2.012702 2.051563 2.153084

Reported cases are returned in a separate data frame in order to streamline the reporting of forecasts and for model evaluation.

    head(summary(estimates, output = "estimated_reported_cases"))
    #>          date   type median     mean        sd lower_90 lower_50 lower_20
    #>        <Date> <char>  <num>    <num>     <num>    <num>    <num>    <num>
    #> 1: 2020-02-22  gp_rt     36  36.2210  9.597511    22.00       30       33
    #> 2: 2020-02-23  gp_rt     52  53.4375 13.289635    34.00       44       50
    #> 3: 2020-02-24  gp_rt     64  65.6005 15.262941    42.00       55       61
    #> 4: 2020-02-25  gp_rt     72  73.3265 16.283718    48.95       62       68
    #> 5: 2020-02-26  gp_rt     82  83.0275 19.168972    54.00       70       77
    #> 6: 2020-02-27  gp_rt    119 121.2740 25.328851    83.00      103      113
    #>    upper_20 upper_50 upper_90
    #>       <num>    <num>    <num>
    #> 1:       38       42    53.00
    #> 2:       56       61    77.00
    #> 3:       68       75    92.05
    #> 4:       76       83   102.00
    #> 5:       87       94   116.05
    #> 6:      126      136   167.00

A range of plots are returned (with the single summary plot shown below). These plots can also be generated using the following `plot` method.

    plot(estimates)

plot of chunk plot_estimates

### regional_epinow()

The `regional_epinow()` function runs the `epinow()` function across multiple regions in an efficient manner.

Define cases in multiple regions delineated by the region variable.

    reported_cases <- data.table::rbindlist(list(
      data.table::copy(reported_cases)[, region := "testland"],
      reported_cases[, region := "realland"]
    ))
    head(reported_cases)
    #>          date confirm   region
    #>        <Date>   <num>   <char>
    #> 1: 2020-02-22      14 testland
    #> 2: 2020-02-23      62 testland
    #> 3: 2020-02-24      53 testland
    #> 4: 2020-02-25      97 testland
    #> 5: 2020-02-26      93 testland
    #> 6: 2020-02-27      78 testland

Calling `regional_epinow()` runs the `epinow()` on each region in turn (or in parallel depending on the settings used). Here we switch to using a weekly random walk rather than the full Gaussian process model giving us piecewise constant estimates by week.

    estimates <- regional_epinow(
      data = reported_cases,
      generation_time = gt_opts(example_generation_time),
      delays = delay_opts(example_incubation_period + reporting_delay),
      rt = rt_opts(prior = LogNormal(mean = 2, sd = 0.2), rw = 7),
      gp = NULL,
      stan = stan_opts(cores = 4, warmup = 250, samples = 1000)
    )
    #> INFO [2025-01-31 17:34:01] Producing following optional outputs: regions, summary, samples, plots, latest
    #> INFO [2025-01-31 17:34:01] Reporting estimates using data up to: 2020-04-21
    #> INFO [2025-01-31 17:34:01] No target directory specified so returning output
    #> INFO [2025-01-31 17:34:01] Producing estimates for: testland, realland
    #> INFO [2025-01-31 17:34:01] Regions excluded: none
    #> INFO [2025-01-31 17:34:21] Completed estimates for: testland
    #> INFO [2025-01-31 17:34:41] Completed estimates for: realland
    #> INFO [2025-01-31 17:34:41] Completed regional estimates
    #> INFO [2025-01-31 17:34:41] Regions with estimates: 2
    #> INFO [2025-01-31 17:34:41] Regions with runtime errors: 0
    #> INFO [2025-01-31 17:34:41] Producing summary
    #> INFO [2025-01-31 17:34:41] No summary directory specified so returning summary output
    #> INFO [2025-01-31 17:34:41] No target directory specified so returning timings

Results from each region are stored in a `regional` list with across region summary measures and plots stored in a `summary` list. All results can be set to be internally saved by setting the `target_folder` and `summary_dir` arguments. Each region can be estimated in parallel using the `{future}` package (when in most scenarios `cores` should be set to 1). For routine use each MCMC chain can also be run in parallel (with `future` = TRUE) with a time out (`max_execution_time`) allowing for partial results to be returned if a subset of chains is running longer than expected. See the documentation for the `{future}` package for details on nested futures.

Summary measures that are returned include a table formatted for reporting (along with raw results for further processing). Futures updated will extend the S3 methods used above to smooth access to this output.

    knitr::kable(estimates$summary$summarised_results$table)

Region | New infections per day | Expected change in reports | Effective reproduction no. | Rate of growth | Doubling/halving time (days)
--- | --- | --- | --- | --- | ---
realland | 2017 (1029 – 3866) | Likely decreasing | 0.85 (0.6 – 1.1) | -0.042 (-0.11 – 0.036) | -17 (19 – -6.1)
testland | 2026 (1026 – 4222) | Likely decreasing | 0.86 (0.6 – 1.2) | -0.04 (-0.12 – 0.042) | -17 (17 – -5.9)

A range of plots are again returned (with the single summary plot shown below).

    estimates$summary$summary_plot

plot of chunk plot_regional_epinow_summary