|
5 | 5 | #' interactive use in epidemic modelling. The arguments provided to the function
|
6 | 6 | #' determine compartments used in the model that is run.
|
7 | 7 | #'
|
8 |
| -#' The convention for pronouncing [ehpi::epi()] is "epi" as in "epidemic" or |
9 |
| -#' "ay pee eye", like API; "epi" is preferred because it reflects the |
10 |
| -#' conventional pronunciation when package-qualified. The package-qualified, |
11 |
| -#' full name is "ehpi epi", and is pronounced like "epi epi". While ehpi |
12 |
| -#' provides "an API" for the Episim Shiny application, it won't enable the |
13 |
| -#' development of applications that provide any feature episim doesn't already |
14 |
| -#' provide by wrapping this package. |
| 8 | +#' The convention for pronouncing [ehpi::epi()] is "epi epi" as if you were |
| 9 | +#' saying "epidemic" twice. If you do want to refer to the package alone, and |
| 10 | +#' not the singular function it packages, you can say "eh pee eye", like "API". |
| 11 | +#' |
| 12 | +#' "eh pee eye" is a tongue-in-cheek Canadianism. You might understand it as, |
| 13 | +#' "Eh, P.I.?", or just a Canadian slant on API. The latter was thought of |
| 14 | +#' first. |
| 15 | +#' |
| 16 | +#' While ehpi provides "an API" for the |
| 17 | +#' [Episim](https://github.com/ashokkrish/episim) Shiny application, it won't |
| 18 | +#' enable the development of applications that provide any feature episim |
| 19 | +#' doesn't already provide by wrapping this package. The function is packages |
| 20 | +#' was extracted from that project to allow associating well-formatted |
| 21 | +#' documentation, vignettes, and examples with the function because that |
| 22 | +#' function is expected to be used outside of Episim, interactively, during |
| 23 | +#' workshops run by Dr. Krishnamurthy. |
15 | 24 | #'
|
16 | 25 | #' @param population The initial number of persons in the simulation; if
|
17 | 26 | #' `vitalDynamics = TRUE` and `muB` and `muD` are equal, then it is constant.
|
|
0 commit comments