Document new data

R/data_doc.R

@@ -13,7 +13,27 @@
 #' `nflfastR` package. Please see `data-raw/divisions.R` for the code to create
 #' this data.
 #' @examples
-#' \donttest{
-#' divisions
-#' }
+#' str(divisions)
 "divisions"
+
+#' Example Games Data used in NFL Simulations
+#'
+#' @docType data
+#' @format A data frame with 284 rows and 9 variables containing NFL schedule
+#' information.
+#' @details
+#'  Please see `data-raw/sim_examples.R` for the code to create this data.
+#' @examples
+#' str(sims_games_example)
+"sims_games_example"
+
+#' Example Teams Data used in NFL Simulations
+#'
+#' @docType data
+#' @format A data frame with 64 rows and 5 variables containing team name and
+#' division information.
+#' @details
+#'  Please see `data-raw/sim_examples.R` for the code to create this data.
+#' @examples
+#' str(sims_teams_example)
+"sims_teams_example"

data-raw/sim_examples.R

@@ -1,5 +1,7 @@
 sims_teams_example <- nflseedR::divisions |>
-  dplyr::filter(!team %in% c("LAR", "STL", "SD", "OAK"))
+  dplyr::filter(!team %in% c("LAR", "STL", "SD", "OAK")) |>
+  strip_nflverse_attributes() |>
+  tibble::as_tibble()
 sims_teams_example <- sims_teams_example[rep(seq_len(nrow(sims_teams_example)), 2), ] |>
   dplyr::mutate(sim = rep(1:2, each = nrow(sims_teams_example))) |>
   select(sim, dplyr::everything())
@@ -18,7 +20,9 @@ sims_games_example <- sims_games_example |>
     result = data.table::fifelse(game_id %in% reset_ids, NA_integer_, result),
     result = data.table::fifelse(game_type == "SB", NA_integer_, result)
   ) |>
-  dplyr::select(-"game_id")
+  dplyr::select(-"game_id") |>
+  strip_nflverse_attributes() |>
+  tibble::as_tibble()
 
 usethis::use_data(sims_teams_example, sims_games_example, overwrite = TRUE)