Actually, provide 'partition_df' as data since it was useful to provi…

…de summaries of the partitions, and some info needed to be anonymized (and thus 'partition_df's origin should be documented)
LieberInstitute · Oct 10, 2023 · f39a3df · f39a3df
1 parent 4574019
commit f39a3df
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 0 deletions.
diff --git a/R/data.R b/R/data.R
@@ -3,3 +3,9 @@
 #' A tibble with 100 rows and 10 columns describing currently running jobs (at
 #' the time of creation)
 "job_info_df"
+
+#' Example output from \code{partition_info(partition = NULL, all_nodes = FALSE)}
+#'
+#' A tibble with 5 rows and 7 columns giving information about memory and CPUs
+#' as available at the time of creation)
+"partition_df"
diff --git a/data-raw/partition_df.R b/data-raw/partition_df.R
@@ -0,0 +1,7 @@
+partition_df = partition_info(partition = NULL, all_nodes = FALSE) |>
+    #   Randomly choose 5 partitions
+    slice_sample(n = 5) |>
+    #   Remove information about true partition names
+    mutate(partition = paste0('partition_', 1:5))
+
+usethis::use_data(partition_df, overwrite = TRUE)
diff --git a/data/partition_df.rda b/data/partition_df.rda
diff --git a/inst/extdata/partition_df.rds b/inst/extdata/partition_df.rds
diff --git a/man/partition_df.Rd b/man/partition_df.Rd