Purely internal need (#1143)

* Purely internal need

* fix

* docs

* docs

* update rd

Author: strengejacke

R/display.R

@@ -2,10 +2,10 @@
 #' @name display.parameters_model
 #'
 #' @description Prints tables (i.e. data frame) in different output formats.
-#' `print_md()` is an alias for `display(format = "markdown")`, `print_html()`
-#' is an alias for `display(format = "html")`, and `print_html(engine = "tt")`
-#' is an alias for `display(format = "tt")`. The latter is a `tinytable` object,
-#' which is either printed as markdown or HTML table, depending on the environment.
+#' `print_md()` is an alias for `display(format = "markdown")` and
+#' `print_html()` is an alias for `display(format = "html")`. A third option is
+#' `display(format = "tt")`, which returns a `tinytable` object, which is either
+#' printed as markdown or HTML table, depending on the environment.
 #'
 #' @param object An object returned by one of the package's function, for example
 #' [`model_parameters()`], [`simulate_parameters()`], [`equivalence_test()`] or
@@ -138,7 +138,7 @@ display.parameters_model <- function(object,
         align = align,
         font_size = font_size,
         line_padding = line_padding,
-        engine = ifelse(format == "tt", "tt", "gt")
+        backend = ifelse(format == "tt", "tt", "html")
       )
     )
     do.call(print_html, c(fun_args, list(...)))
@@ -189,7 +189,7 @@ display.compare_parameters <- function(object,
         column_labels = column_labels,
         font_size = font_size,
         line_padding = line_padding,
-        engine = ifelse(format == "tt", "tt", "gt")
+        backend = ifelse(format == "tt", "tt", "html")
       )
     )
     do.call(print_html, c(fun_args, list(...)))
@@ -219,7 +219,7 @@ display.parameters_sem <- function(object,
     ci_digits = ci_digits,
     p_digits = p_digits,
     ci_brackets = ci_brackets,
-    engine = ifelse(format == "tt", "tt", "gt")
+    backend = ifelse(format == "tt", "tt", "html")
   )
 
   if (format %in% c("html", "tt")) {
@@ -237,7 +237,7 @@ display.parameters_sem <- function(object,
 #' @export
 display.parameters_efa_summary <- function(object, format = "markdown", digits = 3, ...) {
   format <- insight::validate_argument(format, c("markdown", "html", "md", "tt"))
-  fun_args <- list(x = object, digits = digits, engine = ifelse(format == "tt", "tt", "gt"))
+  fun_args <- list(x = object, digits = digits, backend = ifelse(format == "tt", "tt", "html"))
 
   if (format %in% c("html", "tt")) {
     do.call(print_html, c(fun_args, list(...)))
@@ -265,7 +265,7 @@ display.parameters_efa <- function(object, format = "markdown", digits = 2, sort
     sort = sort,
     threshold = threshold,
     labels = labels,
-    engine = ifelse(format == "tt", "tt", "gt")
+    backend = ifelse(format == "tt", "tt", "html")
   )
 
   if (format %in% c("html", "tt")) {
@@ -310,7 +310,7 @@ display.parameters_p_function <- function(object,
     ci_width = ci_width,
     ci_brackets = ci_brackets,
     pretty_names = pretty_names,
-    engine = ifelse(format == "tt", "tt", "gt")
+    backend = ifelse(format == "tt", "tt", "html")
   )
 
   if (format %in% c("html", "tt")) {

R/format.R

@@ -224,7 +224,6 @@ format.compare_parameters <- function(x,
                                       zap_small = FALSE,
                                       format = NULL,
                                       groups = NULL,
-                                      engine = NULL,
                                       ...) {
   m_class <- attributes(x)$model_class
   x$Method <- NULL

R/p_function.R

@@ -443,13 +443,9 @@ print.parameters_p_function <- function(x,
                               ci_brackets = c("(", ")"),
                               pretty_names = TRUE,
                               format = "html",
-                              engine = "gt",
                               ...) {
   # which engine?
-  engine <- insight::validate_argument(
-    getOption("easystats_html_engine", engine),
-    c("gt", "default", "tt")
-  )
+  engine <- .check_format_backend(...)
 
   formatted_table <- format(
     x,

R/print.parameters_model.R

@@ -99,13 +99,6 @@
 #'   categorical predictors. The coefficient for the reference level is always
 #'   `0` (except when `exponentiate = TRUE`, then the coefficient will be `1`),
 #'   so this is just for completeness.
-#' @param engine Character string, naming the package or engine to be used for
-#'   printing into HTML or markdown format. Currently supported `"gt"` (or
-#'   `"default"`) to use the *gt* package to print to HTML and the default easystats
-#'   engine to create markdown tables. If `engine = "tt"`, the *tinytable* package
-#'   is used for printing to HTML or markdown. Not all `print()` methods support
-#'   the `"tt"` engine yet. If a specific `print()` method has no `engine` argument,
-#'   `insight::export_table()` is used, which uses *gt* for HTML printing.
 #' @param ... Arguments passed down to [`format.parameters_model()`],
 #'   [`insight::format_table()`] and [`insight::export_table()`]
 #' @inheritParams insight::format_table
@@ -161,10 +154,6 @@
 #' output, like markdown files). The argument `table_width` can also be used in
 #' most `print()` methods to specify the table width as desired.
 #'
-#' - `easystats_html_engine`: `options(easystats_html_engine = "gt")` will set
-#' the default HTML engine for tables to `gt`, i.e. the _gt_ package is used to
-#' create HTML tables. If set to `tt`, the _tinytable_ package is used.
-#'
 #' - `insight_use_symbols`: `options(insight_use_symbols = TRUE)` will try to
 #' print unicode-chars for symbols as column names, wherever possible (e.g.,
 #' \ifelse{html}{\out{ω}}{\eqn{\omega}} instead of `Omega`).

R/print_html.R

@@ -23,14 +23,10 @@ print_html.parameters_model <- function(x,
                                         line_padding = 4,
                                         column_labels = NULL,
                                         include_reference = FALSE,
-                                        engine = "gt",
                                         verbose = TRUE,
                                         ...) {
   # which engine?
-  engine <- insight::validate_argument(
-    getOption("easystats_html_engine", engine),
-    c("gt", "default", "tt")
-  )
+  engine <- .check_format_backend(...)
 
   # line separator - for tinytable, we have no specific line separator,
   # because the output format is context-dependent
@@ -123,7 +119,7 @@ print_html.parameters_model <- function(x,
 
   out <- insight::export_table(
     formatted_table,
-    format = ifelse(identical(engine, "tt"), "tt", "html"),
+    format = engine,
     caption = table_caption,
     subtitle = subtitle,
     footer = footer,
@@ -170,7 +166,6 @@ print_html.compare_parameters <- function(x,
                                           font_size = "100%",
                                           line_padding = 4,
                                           column_labels = NULL,
-                                          engine = "gt",
                                           ...) {
   # check if user supplied digits attributes
   if (missing(digits)) {
@@ -191,10 +186,7 @@ print_html.compare_parameters <- function(x,
   }
 
   # which engine?
-  engine <- insight::validate_argument(
-    getOption("easystats_html_engine", engine),
-    c("gt", "default", "tt")
-  )
+  engine <- .check_format_backend(...)
 
   # line separator - for tinytable, we have no specific line separator,
   # because the output format is context-dependent
@@ -261,7 +253,7 @@ print_html.compare_parameters <- function(x,
 
   out <- insight::export_table(
     formatted_table,
-    format = ifelse(identical(engine, "tt"), "tt", "html"),
+    format = engine,
     caption = caption, # TODO: get rid of NOTE
     subtitle = subtitle,
     footer = footer,
@@ -297,14 +289,7 @@ print_html.parameters_efa <- function(x,
                                       sort = FALSE,
                                       threshold = NULL,
                                       labels = NULL,
-                                      engine = "gt",
                                       ...) {
-  # which engine?
-  engine <- insight::validate_argument(
-    getOption("easystats_html_engine", engine),
-    c("gt", "default", "tt")
-  )
-
   # extract attributes
   if (is.null(threshold)) {
     threshold <- attributes(x)$threshold
@@ -313,7 +298,7 @@ print_html.parameters_efa <- function(x,
     x,
     threshold = threshold,
     sort = sort,
-    format = ifelse(identical(engine, "tt"), "tt", "html"),
+    format = "html",
     digits = digits,
     labels = labels,
     ...
@@ -325,12 +310,9 @@ print_html.parameters_pca <- print_html.parameters_efa
 
 
 #' @export
-print_html.parameters_efa_summary <- function(x, digits = 3, engine = "gt", ...) {
+print_html.parameters_efa_summary <- function(x, digits = 3, ...) {
   # html engine?
-  engine <- insight::validate_argument(
-    getOption("easystats_html_engine", engine),
-    c("gt", "default", "tt")
-  )
+  engine <- .check_format_backend(...)
 
   table_caption <- "(Explained) Variance of Components"
 
@@ -354,7 +336,7 @@ print_html.parameters_efa_summary <- function(x, digits = 3, engine = "gt", ...)
   insight::export_table(
     x,
     digits = digits,
-    format = ifelse(identical(engine, "tt"), "tt", "html"),
+    format = engine,
     caption = table_caption,
     align = "firstleft"
   )
@@ -372,7 +354,6 @@ print_html.parameters_p_function <- function(x,
                                              ci_width = "auto",
                                              ci_brackets = c("(", ")"),
                                              pretty_names = TRUE,
-                                             engine = "gt",
                                              ...) {
   .print_p_function(
     x,
@@ -381,7 +362,6 @@ print_html.parameters_p_function <- function(x,
     ci_brackets,
     pretty_names,
     format = "html",
-    engine = engine,
     ...
   )
 }
@@ -457,3 +437,14 @@ print_html.parameters_p_function <- function(x,
   )
   out
 }
+
+
+# we allow exporting HTML format based on "gt" or "tinytable"
+.check_format_backend <- function(...) {
+  dots <- list(...)
+  if (identical(dots$backend, "tt")) {
+    "tt"
+  } else {
+    "html"
+  }
+}

R/standardize_parameters.R

@@ -525,9 +525,10 @@ display.parameters_standardized <- function(object,
                                             digits = 2,
                                             ...) {
   format <- insight::validate_argument(format, c("markdown", "html", "md", "tt"))
-  fun_args <- list(x = object, digits = digits, engine = ifelse(format == "tt", "tt", "gt"))
+  fun_args <- list(x = object, digits = digits)
 
   if (format %in% c("html", "tt")) {
+    fun_args$backend <- format
     do.call(print_html, c(fun_args, list(...)))
   } else {
     do.call(print_md, c(fun_args, list(...)))
@@ -549,14 +550,12 @@ print_md.parameters_standardized <- function(x, digits = 2, ...) {
 }
 
 #' @export
-print_html.parameters_standardized <- function(x, digits = 2, engine = "gt", ...) {
+print_html.parameters_standardized <- function(x, digits = 2, ...) {
   # which engine?
-  engine <- insight::validate_argument(
-    getOption("easystats_html_engine", engine),
-    c("gt", "default", "tt")
-  )
+  engine <- .check_format_backend(...)
+
   x_fmt <- format(x, digits = digits, output = "html", ...)
-  insight::export_table(x_fmt, format = ifelse(identical(engine, "tt"), "tt", "html"), ...)
+  insight::export_table(x_fmt, format = engine, ...)
 }
 
 

R/utils_pca_efa.R

@@ -363,12 +363,9 @@ print.parameters_omega_summary <- function(x, ...) {
 }
 
 
-.print_parameters_cfa_efa <- function(x, threshold, sort, format, digits, labels, engine = "gt", ...) {
+.print_parameters_cfa_efa <- function(x, threshold, sort, format, digits, labels, ...) {
   # html engine?
-  engine <- insight::validate_argument(
-    getOption("easystats_html_engine", engine),
-    c("gt", "default", "tt")
-  )
+  engine <- .check_format_backend(...)
 
   # Method
   if (inherits(x, "parameters_pca")) {