diff options
| author | Naeem Model <me@nmode.ca> | 2024-02-12 00:05:56 +0000 |
|---|---|---|
| committer | Naeem Model <me@nmode.ca> | 2024-02-12 00:05:56 +0000 |
| commit | eeaabbdfcedc832c78b253d92b95e48e61498716 (patch) | |
| tree | dfa421e34df46e239cd5675ea4c9bd5aea7c04f4 | |
| parent | e5e312d01bccbabbb21e69d269ccf0d947e5abdb (diff) | |
Update seqB documentation
| -rw-r--r-- | R/seq_bayes.R | 8 | ||||
| -rw-r--r-- | man/seq_bayes.Rd | 8 |
2 files changed, 12 insertions, 4 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) { diff --git a/man/seq_bayes.Rd b/man/seq_bayes.Rd index 8dc824c..9cb6db9 100644 --- a/man/seq_bayes.Rd +++ b/man/seq_bayes.Rd @@ -30,7 +30,7 @@ If \code{post} is identical to \code{TRUE}, a list containing the following components is returned: \itemize{ \item \code{supp} - the support of the posterior distribution of R0 -\item \code{pmf} - the probability mass function of the posterior distribution +\item \code{pmf} - the probability mass function of the posterior distribution of R0 } Otherwise, if \code{post} is identical to \code{FALSE}, only the estimate of R0 is @@ -80,10 +80,14 @@ seq_bayes(cases, mu = 3 / 7) # 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) } |