Skip to content

Commit 6632953

Browse files
committed
Update the explanation of how to pronounce ehpi::epi.
1 parent 9e4c02a commit 6632953

File tree

2 files changed

+32
-14
lines changed

2 files changed

+32
-14
lines changed

R/epi.R

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,22 @@
55
#' interactive use in epidemic modelling. The arguments provided to the function
66
#' determine compartments used in the model that is run.
77
#'
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.
1524
#'
1625
#' @param population The initial number of persons in the simulation; if
1726
#' `vitalDynamics = TRUE` and `muB` and `muD` are equal, then it is constant.

man/epi.Rd

Lines changed: 16 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)