Merge pull request #404 from spsanderson/development

Fixes #401
spsanderson · Feb 13, 2024 · 7e9456d · 7e9456d
2 parents 337e0b0 + db6b5ff
commit 7e9456d
Show file tree

Hide file tree

Showing 33 changed files with 85 additions and 68 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -15,8 +15,8 @@ Description:
 License: MIT + file LICENSE
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.2.3
-URL: https://www.spsanderson.com/TidyDensity/, https://github.com/spsanderson/TidyDensity
+RoxygenNote: 7.3.1
+URL: https://github.com/spsanderson/TidyDensity
 BugReports: https://github.com/spsanderson/TidyDensity/issues
 Depends:
     R (>= 4.1.0)

diff --git a/NEWS.md b/NEWS.md
@@ -7,7 +7,7 @@ None
 None
 
 ## Minor Fixes and Improvements
-None
+1. Fix #401 - Update `tidy_multi_single_dist()` to respect the `.return_tibble` parameter
 
 # TidyDensity 1.3.0
 

diff --git a/R/combine-multi-single-dist-tbl.R b/R/combine-multi-single-dist-tbl.R
@@ -18,6 +18,7 @@
 #' want to pass through to the TidyDensity `tidy_` distribution function.
 #'
 #' @examples
+#'
 #' tidy_multi_single_dist(
 #'   .tidy_dist = "tidy_normal",
 #'   .param_list = list(
@@ -29,6 +30,17 @@
 #'   )
 #' )
 #'
+#' tidy_multi_single_dist(
+#'   .tidy_dist = "tidy_normal",
+#'   .param_list = list(
+#'     .n = 50,
+#'     .mean = c(-1, 0, 1),
+#'     .sd = 1,
+#'     .num_sims = 3,
+#'     .return_tibble = FALSE
+#'   )
+#' )
+#'
 #' @return
 #' A tibble
 #'
@@ -70,16 +82,11 @@ tidy_multi_single_dist <- function(.tidy_dist = NULL,
   # Run call on the grouped df ----
   dff <- param_grid |>
     dplyr::mutate(results = purrr::pmap(dplyr::pick(dplyr::everything()), match.fun(td)))
-    #dplyr::mutate(results = purrr::pmap(dplyr::cur_data(), match.fun(td)))
 
   # Get the attributes to be used later on ----
   atb <- dff$results[[1]] |> attributes()
 
   # Make Dist Type for column ----
-  # dist_type <- stringr::str_remove(atb$tibble_type, "tidy_") |>
-  #   stringr::str_replace_all(pattern = "_", " ") |>
-  #   stringr::str_to_title()
-
   dist_type <- dist_type_extractor(atb$tibble_type)
 
   # Get column names from the param_grid in order to make teh dist_type column ----
@@ -95,19 +102,17 @@ tidy_multi_single_dist <- function(.tidy_dist = NULL,
     )
   }
 
-  # dff$dist_name <- paste0(
-  #   paste0(dist_type, " c("),
-  #   apply(dff[, cols], 1, paste0, collapse = ", "),
-  #   ")"
-  # )
-
   df_unnested_tbl <- dff |>
     tidyr::unnest(results) |>
     dplyr::ungroup() |>
     dplyr::select(sim_number, dist_name, x:q) |>
     dplyr::mutate(dist_name = as.factor(dist_name)) |>
     dplyr::arrange(sim_number, dist_name)
 
+  if (params$.return_tibble == FALSE) {
+    df_unnested_tbl <- data.table::as.data.table(df_unnested_tbl)
+  }
+
   # Attach attributes ----
   attr(df_unnested_tbl, "all") <- atb
   attr(df_unnested_tbl, "tibble_type") <- atb$tibble_type

diff --git a/man/tidy_beta.Rd b/man/tidy_beta.Rd
diff --git a/man/tidy_burr.Rd b/man/tidy_burr.Rd
diff --git a/man/tidy_cauchy.Rd b/man/tidy_cauchy.Rd
diff --git a/man/tidy_chisquare.Rd b/man/tidy_chisquare.Rd
diff --git a/man/tidy_exponential.Rd b/man/tidy_exponential.Rd
diff --git a/man/tidy_f.Rd b/man/tidy_f.Rd
diff --git a/man/tidy_gamma.Rd b/man/tidy_gamma.Rd
diff --git a/man/tidy_generalized_beta.Rd b/man/tidy_generalized_beta.Rd
diff --git a/man/tidy_generalized_pareto.Rd b/man/tidy_generalized_pareto.Rd
diff --git a/man/tidy_geometric.Rd b/man/tidy_geometric.Rd
diff --git a/man/tidy_inverse_burr.Rd b/man/tidy_inverse_burr.Rd
diff --git a/man/tidy_inverse_exponential.Rd b/man/tidy_inverse_exponential.Rd
diff --git a/man/tidy_inverse_gamma.Rd b/man/tidy_inverse_gamma.Rd
diff --git a/man/tidy_inverse_normal.Rd b/man/tidy_inverse_normal.Rd
diff --git a/man/tidy_inverse_pareto.Rd b/man/tidy_inverse_pareto.Rd
diff --git a/man/tidy_inverse_weibull.Rd b/man/tidy_inverse_weibull.Rd
diff --git a/man/tidy_logistic.Rd b/man/tidy_logistic.Rd
diff --git a/man/tidy_lognormal.Rd b/man/tidy_lognormal.Rd
diff --git a/man/tidy_multi_single_dist.Rd b/man/tidy_multi_single_dist.Rd
diff --git a/man/tidy_normal.Rd b/man/tidy_normal.Rd
diff --git a/man/tidy_paralogistic.Rd b/man/tidy_paralogistic.Rd
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,7 +7,7 @@ None @@
     None
     ## Minor Fixes and Improvements
-    None
+. Fix #401 - Update `tidy_multi_single_dist()` to respect the `.return_tibble` parameter
     # TidyDensity 1.3.0
@@ Expand Down @@