future global option

Author: vincentarelbundock

R/modelsummary.R

@@ -702,7 +702,8 @@ get_list_of_modelsummary_lists <- function(models, conf_level, vcov, gof_map, sh
     # {future}
     } else if (isTRUE(check_dependency("future.apply")) &&
                future::nbrOfWorkers() > 1 &&
-               number_of_models > 1) {
+               number_of_models > 1 &&
+               isTRUE(getOption("modelsummary_future", default = TRUE))) {
         out <- future.apply::future_lapply(seq_len(number_of_models), inner_loop, future.seed = TRUE)
 
     # sequential

man-roxygen/modelsummary_parallel.R

@@ -18,12 +18,18 @@
 #' ```{r, eval = FALSE}
 #' library(future.apply)
 #' plan(multicore, workers = 4)
+#' options("modelsummary_future" = TRUE)
 #' modelsummary(model_list)
 #' ```
 #'
 #' Note that the "multicore" plan only parallelizes under mac or linux. Windows
-#' users can use `plan(multisession)' instead. However, note that the first
+#' users can use `plan(multisession)` instead. However, note that the first
 #' time `modelsummary()` is called under multisession can be a fair bit longer,
 #' because of extra costs in passing data to and loading required packages on
 #' to workers. Subsequent calls to `modelsummary()` will often be much faster.
 #'
+#' Some users have reported difficult to reproduce errors when using the
+#' `future` package with some packages. The `future` parallelization in
+#' `modelsummary` can be disabled by calling:
+#'
+#' `options("modelsummary_future" = FALSE)`