Merge pull request #25 from sempwn/dev

Re #24 Fix descriptions.

DESCRIPTION

@@ -2,13 +2,11 @@ Package: bennu
 Title: Bayesian Estimation of Naloxone Kit Number Under-Reporting
 Version: 0.2.1.9000
 Authors@R: c(
-    person(given = "Mike",
-           family = "Irvine",
-           role = c("aut", "cre","cph"),
-           email = "mike.irvine@bccdc.ca",
+    person("Mike", "Irvine", , "mike.irvine@bccdc.ca", role = c("aut", "cre", "cph"),
            comment = c(ORCID = "0000-0003-4785-8998")),
-    person("Samantha","Bardwell",role="ctb")
-           )
+    person("Samantha", "Bardwell", role = "ctb"),
+    person("Andrew", "Johnson", role = "ctb")
+  )
 Description: Bayesian model and associated tools for generating estimates of 
     total naloxone kit numbers distributed and used from naloxone kit orders 
     data. Provides functions for generating simulated data of naloxone kit use

R/est_naloxone.R

@@ -28,7 +28,7 @@
 #' @param adapt_delta (double, between 0 and 1, defaults to 0.8)
 #' @param ... other parameters to pass to [rstan::sampling]
 #' @family inference
-#' @return An S4 stanfit class object containing the fitted model
+#' @return An S4 [rstan::stanfit] class object containing the fitted model
 #' @export
 est_naloxone_vec <- function(N_region, N_t, N_distributed, regions,
                              times, Orders2D, Reported_Distributed,
@@ -143,7 +143,7 @@ est_naloxone_vec <- function(N_region, N_t, N_distributed, regions,
 #' }
 #' @inheritParams est_naloxone_vec
 #' @family inference
-#' @return An S4 stanfit class object containing the fitted model
+#' @return An S4 [rstan::stanfit] class object containing the fitted model
 #' @export
 est_naloxone <- function(d,
                          psi_vec = c(0.7, 0.2, 0.1),

R/generate_model_data.R

@@ -20,7 +20,7 @@
 #' @param c_region logit probability of kit use per region
 #' @param reporting_freq The frequency that distribution data is provided.
 #'  If `NULL` distribution frequency matches orders frequency
-#' @return A tibble
+#' @return A [tibble]
 #' \describe{
 #'   \item{Orders}{Kit orders per time and region}
 #'   \item{regions}{Numeric index indicating region of orders and distributions}

R/utils-table.R

@@ -21,14 +21,14 @@
 #' ensure breaks have the minimum number of digits needed to show the
 #' difference between adjacent values.
 #' @param cri_range The range of the credible interval e.g. 0.95
-#' @return [dplyr::tibble]
-#' \describe{
-#'   \item{Probability of kit use if distributed}{}
-#'   \item{Estimated as distributed}{}
-#'   \item{Proportion kits distributed that are reported}{}
-#'   \item{Estimated kits used}{}
-#'   \item{Proportion kits used that are reported}{}
-#'   \item{Proportion kits ordered that are used}{}
+#' @return A [tibble::tibble]
+#' \itemize{
+#'   \item{Probability of kit use if distributed}
+#'   \item{Estimated as distributed}
+#'   \item{Proportion kits distributed that are reported}
+#'   \item{Estimated kits used}
+#'   \item{Proportion kits used that are reported}
+#'   \item{Proportion kits ordered that are used}
 #' }
 #' @export
 #'