Skip to content

Commit

Permalink
Improve explanation of susceptible depletion feature
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesmbaazam committed Mar 27, 2024
1 parent df312e4 commit 0ef7e2b
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions vignettes/epichains.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -312,9 +312,9 @@ head(sim_chains)
```

::: {.alert .alert-info}
Beyond the defaults, `simulate_chains()` can also simulate outbreaks based on
a specified population size and pre-existing immunity until the susceptible
pool runs out.
By default, `simulate_chains()` assumes an infinite population but can account for susceptible depletion when a finite `pop` is specified.

Pre-existing immunity levels can also be specified, which will be applied to `pop` before the simulation is initialised.
:::

Here is a quick example where we simulate an outbreak in a population of
Expand Down

0 comments on commit 0ef7e2b

Please sign in to comment.