add example for estimates_exist; closes #35

R/estimate_mse.R

@@ -160,6 +160,22 @@ run_lcmcr <- function(stratum_data_prepped, stratum_name, min_n = 1,
 #' full file path to the JSON file containing the estimates, otherwise it will
 #' be `NA`.
 #' @export
+#' @importFrom dplyr "%>%"
+#'
+#' @examples
+#' \dontrun{
+#' in_A <- sample(c(0, 1), size = 100, replace = TRUE, prob = c(0.45, 0.65))
+#' in_B <- sample(c(0, 1), size = 100, replace = TRUE, prob = c(0.5, 0.5))
+#' in_C <- sample(c(0, 1), size = 100, replace = TRUE, prob = c(0.75, 0.25))
+#' in_D <- sample(c(0, 1), size = 100, replace = TRUE, prob = c(1, 0))
+#'
+#' my_stratum <- tibble::tibble(in_A, in_B, in_C, in_D) %>%
+#'     dplyr::mutate(rs = rowSums(.)) %>%
+#'     dplyr::filter(rs >= 1) %>%
+#'     dplyr::select(-rs)
+#'
+#' estimates_exist(stratum_data_prepped = my_stratum, estimates_dir = "path_to_estimates")
+#' }
 
 estimates_exist <- function(stratum_data_prepped, estimates_dir) {