summaryrefslogtreecommitdiff
path: root/R/seq_bayes.R
diff options
context:
space:
mode:
Diffstat (limited to 'R/seq_bayes.R')
-rw-r--r--R/seq_bayes.R8
1 files changed, 6 insertions, 2 deletions
diff --git a/R/seq_bayes.R b/R/seq_bayes.R
index 2f87121..59b7b4b 100644
--- a/R/seq_bayes.R
+++ b/R/seq_bayes.R
@@ -45,7 +45,7 @@
#' @return If `post` is identical to `TRUE`, a list containing the following
#' components is returned:
#' * `supp` - the support of the posterior distribution of R0
-#' * `pmf` - the probability mass function of the posterior distribution
+#' * `pmf` - the probability mass function of the posterior distribution of R0
#'
#' Otherwise, if `post` is identical to `FALSE`, only the estimate of R0 is
#' returned. Note that the estimate is equal to `sum(supp * pmf)` (i.e., the
@@ -74,10 +74,14 @@
#' # believed to be at most 4.
#' estimate <- seq_bayes(cases, mu = 1, kappa = 4)
#'
-#' # Same as above, but return the posterior distribution instead of the
+#' # Same as above, but return the posterior distribution of R0 instead of the
#' # estimate.
#' posterior <- seq_bayes(cases, mu = 1, kappa = 4, post = TRUE)
#'
+#' # Display the support and probability mass function of the posterior.
+#' posterior$supp
+#' posterior$pmf
+#'
#' # Note that the following always holds:
#' estimate == sum(posterior$supp * posterior$pmf)
seq_bayes <- function(cases, mu, kappa = 20, post = FALSE) {