digits display option doesn't get passed to AIC/BIC (#863)

Author: strengejacke

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: performance
 Title: Assessment of Regression Models Performance
-Version: 0.15.2
+Version: 0.15.2.1
 Authors@R:
     c(person(given = "Daniel",
              family = "Lüdecke",

NEWS.md

@@ -1,3 +1,9 @@
+# performance (devel)
+
+## Changes
+
+* Improved documentation for printing-methods.
+
 # performance 0.15.2
 
 ## Bug fixes

R/display.R

@@ -13,7 +13,10 @@
 #' @param layout Table layout (can be either `"horizontal"` or `"vertical"`).
 #' @param digits Number of decimal places.
 #' @param caption Table caption as string. If `NULL`, no table caption is printed.
-#' @param ... Currently not used.
+#' @param ... Arguments passed to other methods, e.g. `format()` (and thereby to
+#' [`insight::format_table()`] or [`insight::export_table()`]. See related
+#' documentation for details on available arguments. For example, to control
+#' digits for information criteria like AIC or BIC, use `ic_digits = <value>`.
 #'
 #' @section Global Options to Customize Output when Printing:
 #'
@@ -35,6 +38,7 @@
 #' model <- lm(mpg ~ wt + cyl, data = mtcars)
 #' mp <- model_performance(model)
 #' display(mp)
+#' display(mp, digits = 3, ic_digits = 4)
 #' @export
 display.performance_model <- function(
   object,

R/model_performance.R

@@ -39,36 +39,3 @@ model_performance <- function(model, ...) {
 #' @rdname model_performance
 #' @export
 performance <- model_performance
-
-
-# methods --------------------------------
-
-#' @export
-print.performance_model <- function(x, digits = 3, layout = "horizontal", ...) {
-  layout <- insight::validate_argument(
-    layout,
-    c("horizontal", "vertical")
-  )
-  formatted_table <- format(x = x, digits = digits, format = "text", ...)
-
-  # switch to vertical layout
-  if (layout == "vertical") {
-    formatted_table <- datawizard::rownames_as_column(
-      as.data.frame(t(formatted_table)),
-      "Metric"
-    )
-    colnames(formatted_table)[2] <- "Value"
-  }
-
-  cat(
-    insight::export_table(
-      x = formatted_table,
-      digits = digits,
-      format = "text",
-      caption = c("# Indices of model performance", "blue"),
-      ...
-    )
-  )
-
-  invisible(x)
-}

R/print-methods.R

@@ -1,3 +1,35 @@
+#' @rdname display.performance_model
+#' @export
+print.performance_model <- function(x, digits = 3, layout = "horizontal", ...) {
+  layout <- insight::validate_argument(
+    layout,
+    c("horizontal", "vertical")
+  )
+  formatted_table <- format(x = x, digits = digits, format = "text", ...)
+
+  # switch to vertical layout
+  if (layout == "vertical") {
+    formatted_table <- datawizard::rownames_as_column(
+      as.data.frame(t(formatted_table)),
+      "Metric"
+    )
+    colnames(formatted_table)[2] <- "Value"
+  }
+
+  cat(
+    insight::export_table(
+      x = formatted_table,
+      digits = digits,
+      format = "text",
+      caption = c("# Indices of model performance", "blue"),
+      ...
+    )
+  )
+
+  invisible(x)
+}
+
+
 #' @export
 print.r2_generic <- function(x, digits = 3, ...) {
   model_type <- attr(x, "model_type")