jupyter does not return TRUE + datasummary_balance test fix

Author: vincentarelbundock

NEWS.md

@@ -12,6 +12,7 @@
 Misc:
 
 * Bugfix: rounding in LaTeX w/ siunitx and NaN entries.
+* output='jupyter' no longer prints an extraneousnTRUE to the notebook
 
 # modelsummary 0.9.2
 

R/datasummary.R

@@ -222,9 +222,15 @@ datasummary <- function(formula,
     add_rows = add_rows,
     ...)
 
-  if (!is.null(settings_get("output_file"))) {
+  # invisible return
+  if (!is.null(settings_get("output_file")) ||
+      output == "jupyter" ||
+      (output == "default" && settings_equal("output_default", "jupyter"))) {
+    settings_rm()
     return(invisible(out))
+  # visible return
   } else {
+    settings_rm()
     return(out)
   }
 

R/datasummary_balance.R

@@ -233,12 +233,16 @@ datasummary_balance <- function(formula,
         escape = escape,
         ...)
 
-    if (!is.null(settings_get("output_file"))) {
-        settings_rm()
-        return(invisible(out))
+    # invisible return
+    if (!is.null(settings_get("output_file")) ||
+        output == "jupyter" ||
+        (output == "default" && settings_equal("output_default", "jupyter"))) {
+      settings_rm()
+      return(invisible(out))
+    # visible return
     } else {
-        settings_rm()
-        return(out)
+      settings_rm()
+      return(out)
     }
 
 }

R/datasummary_correlation.R

@@ -195,9 +195,14 @@ datasummary_correlation <- function(data,
     title = title,
     ...)
 
-  if (!is.null(settings_get("output_file"))) {
+
+  # invisible return
+  if (!is.null(settings_get("output_file")) ||
+      output == "jupyter" ||
+      (output == "default" && settings_equal("output_default", "jupyter"))) {
     settings_rm()
     return(invisible(out))
+  # visible return
   } else {
     settings_rm()
     return(out)

R/datasummary_skim.R

@@ -355,14 +355,12 @@ datasummary_skim_categorical <- function(
   f <- All(dat_new, numeric = FALSE, factor = TRUE, logical = TRUE, character = TRUE) ~
        (N = 1) * Format() + (`%` = Percent()) * Format(pctformat())
 
-  out <- datasummary(
+  datasummary(
     formula = f,
     data = dat_new,
     output = output,
     title = title,
     align = align,
     notes = notes)
 
-  return(out)
-
 }

R/modelsummary.R

@@ -428,9 +428,13 @@ modelsummary <- function(
     ...
   )
 
-  if (!is.null(settings_get("output_file"))) {
+  # invisible return
+  if (!is.null(settings_get("output_file")) ||
+      output == "jupyter" ||
+      (output == "default" && settings_equal("output_default", "jupyter"))) {
     settings_rm()
     return(invisible(out))
+  # visible return
   } else {
     settings_rm()
     return(out)

tests/testthat/_snaps/datasummary_balance.md

@@ -11,16 +11,16 @@
       \cmidrule(l{3pt}r{3pt}){2-3} \cmidrule(l{3pt}r{3pt}){4-5}
         & Mean & Std. Dev. & Mean  & Std. Dev.  & Diff. in Means & Std. Error\\
       \midrule
-      mpg & 16.6 & 3.9 & 24.6 & 5.4 & \num{7.9} & \num{1.7}\\
-      cyl & 7.4 & 1.1 & 4.6 & 0.9 & \num{-2.9} & \num{0.4}\\
-      disp & 307.1 & 106.8 & 132.5 & 56.9 & \num{-174.7} & \num{29.4}\\
-      hp & 189.7 & 60.3 & 91.4 & 24.4 & \num{-98.4} & \num{15.6}\\
-      drat & 3.4 & 0.5 & 3.9 & 0.5 & \num{0.5} & \num{0.2}\\
-      wt & 3.7 & 0.9 & 2.6 & 0.7 & \num{-1.1} & \num{0.3}\\
-      qsec & 16.7 & 1.1 & 19.3 & 1.4 & \num{2.6} & \num{0.4}\\
-      am & 0.3 & 0.5 & 0.5 & 0.5 & \num{0.2} & \num{0.2}\\
-      gear & 3.6 & 0.9 & 3.9 & 0.5 & \num{0.3} & \num{0.2}\\
-      carb & 3.6 & 1.5 & 1.8 & 1.1 & \num{-1.8} & \num{0.5}\\
+      mpg & 16.6 & 3.9 & 24.6 & 5.4 & 7.9 & 1.7\\
+      cyl & 7.4 & 1.1 & 4.6 & 0.9 & -2.9 & 0.4\\
+      disp & 307.1 & 106.8 & 132.5 & 56.9 & -174.7 & 29.4\\
+      hp & 189.7 & 60.3 & 91.4 & 24.4 & -98.4 & 15.6\\
+      drat & 3.4 & 0.5 & 3.9 & 0.5 & 0.5 & 0.2\\
+      wt & 3.7 & 0.9 & 2.6 & 0.7 & -1.1 & 0.3\\
+      qsec & 16.7 & 1.1 & 19.3 & 1.4 & 2.6 & 0.4\\
+      am & 0.3 & 0.5 & 0.5 & 0.5 & 0.2 & 0.2\\
+      gear & 3.6 & 0.9 & 3.9 & 0.5 & 0.3 & 0.2\\
+      carb & 3.6 & 1.5 & 1.8 & 1.1 & -1.8 & 0.5\\
       \bottomrule
       \end{tabular}
       \end{table}
@@ -38,16 +38,16 @@
       \cmidrule(l{3pt}r{3pt}){2-3} \cmidrule(l{3pt}r{3pt}){4-5}
         & Mean & Std. Dev. & Mean  & Std. Dev.  & Diff. in Means & Std. Error\\
       \midrule
-      mpg & 16.6 & 3.9 & 24.6 & 5.4 & \num{7.9} & \num{1.7}\\
-      cyl & 7.4 & 1.1 & 4.6 & 0.9 & \num{-2.9} & \num{0.4}\\
-      disp & 307.1 & 106.8 & 132.5 & 56.9 & \num{-174.7} & \num{29.4}\\
-      hp & 189.7 & 60.3 & 91.4 & 24.4 & \num{-98.4} & \num{15.6}\\
-      drat & 3.4 & 0.5 & 3.9 & 0.5 & \num{0.5} & \num{0.2}\\
-      wt & 3.7 & 0.9 & 2.6 & 0.7 & \num{-1.1} & \num{0.3}\\
-      qsec & 16.7 & 1.1 & 19.3 & 1.4 & \num{2.6} & \num{0.4}\\
-      am & 0.3 & 0.5 & 0.5 & 0.5 & \num{0.2} & \num{0.2}\\
-      gear & 3.6 & 0.9 & 3.9 & 0.5 & \num{0.3} & \num{0.2}\\
-      carb & 3.6 & 1.5 & 1.8 & 1.1 & \num{-1.8} & \num{0.5}\\
+      mpg & 16.6 & 3.9 & 24.6 & 5.4 & 7.9 & 1.7\\
+      cyl & 7.4 & 1.1 & 4.6 & 0.9 & -2.9 & 0.4\\
+      disp & 307.1 & 106.8 & 132.5 & 56.9 & -174.7 & 29.4\\
+      hp & 189.7 & 60.3 & 91.4 & 24.4 & -98.4 & 15.6\\
+      drat & 3.4 & 0.5 & 3.9 & 0.5 & 0.5 & 0.2\\
+      wt & 3.7 & 0.9 & 2.6 & 0.7 & -1.1 & 0.3\\
+      qsec & 16.7 & 1.1 & 19.3 & 1.4 & 2.6 & 0.4\\
+      am & 0.3 & 0.5 & 0.5 & 0.5 & 0.2 & 0.2\\
+      gear & 3.6 & 0.9 & 3.9 & 0.5 & 0.3 & 0.2\\
+      carb & 3.6 & 1.5 & 1.8 & 1.1 & -1.8 & 0.5\\
       \bottomrule
       \end{tabular}
       \end{table}