Allow `export_table()` to split to more than 3 tables #952

mattansb · 2024-10-30T13:59:32Z

Closes #951

It's not set to auto, because sometimes a horizontal scrollbar is better than a split table, when it's just one column too wide.

Originally posted by @strengejacke in #951 (comment)

The current implementation will never make a split that leaves a single column table.

z <- mtcars[1,] |> 
  insight::export_table(table_width = NULL) |> 
  strsplit(split = "\n") |> _[[1]]

nchar(z[1], type = "width")
#> [1] 68

# output is too wide, but it will not split a single column
mtcars[1:5,] |> 
  insight::export_table(table_width = 67)
#>   mpg | cyl | disp |  hp | drat |   wt |  qsec | vs | am | gear | carb
#> ----------------------------------------------------------------------
#> 21.00 |   6 |  160 | 110 | 3.90 | 2.62 | 16.46 |  0 |  1 |    4 |    4
#> 21.00 |   6 |  160 | 110 | 3.90 | 2.88 | 17.02 |  0 |  1 |    4 |    4
#> 22.80 |   4 |  108 |  93 | 3.85 | 2.32 | 18.61 |  1 |  1 |    4 |    1
#> 21.40 |   6 |  258 | 110 | 3.08 | 3.21 | 19.44 |  1 |  0 |    3 |    1
#> 18.70 |   8 |  360 | 175 | 3.15 | 3.44 | 17.02 |  0 |  0 |    3 |    2

^{Created on 2024-10-30 with reprex v2.1.1}

So I think it's safe to set table_width = "auto" as the default. WDYT?

bwiernik · 2024-10-30T14:26:58Z

I think that would be better.

One other thing I wonder—could we repeat the model label columns on each line so that output with many models are able to be read easily on subsequent rows?

strengejacke · 2024-10-30T15:12:41Z

This PR is not fully working yet. See this example (from https://easystats.github.io/parameters/articles/model_parameters_print.html#splitting-wide-tables-into-multiple-table-parts):

library(parameters)
data(iris)
lm1 <- lm(Sepal.Length ~ Species, data = iris)
lm2 <- lm(Sepal.Length ~ Species + Petal.Length, data = iris)
lm3 <- lm(Sepal.Length ~ Species * Petal.Length, data = iris)
lm4 <- lm(Sepal.Length ~ Species * Petal.Length + Petal.Width, data = iris)

tab <- compare_parameters(lm1, lm2, lm3, lm4)
print(tab, table_width = 80)

The first column should be repeated for each table.

Current PR

library(parameters)
data(iris)
lm1 <- lm(Sepal.Length ~ Species, data = iris)
lm2 <- lm(Sepal.Length ~ Species + Petal.Length, data = iris)
lm3 <- lm(Sepal.Length ~ Species * Petal.Length, data = iris)
lm4 <- lm(Sepal.Length ~ Species * Petal.Length + Petal.Width, data = iris)

tab <- compare_parameters(lm1, lm2, lm3, lm4)
print(tab, table_width = 80)
#> Parameter                           |               lm1 |                  lm2
#> ------------------------------------------------------------------------------
#> (Intercept)                         | 5.01 (4.86, 5.15) |  3.68 ( 3.47,  3.89)
#> Species [versicolor]                | 0.93 (0.73, 1.13) | -1.60 (-1.98, -1.22)
#> Species [virginica]                 | 1.58 (1.38, 1.79) | -2.12 (-2.66, -1.58)
#> Petal Length                        |                   |  0.90 ( 0.78,  1.03)
#> Species [versicolor] × Petal Length |                   |                     
#> Species [virginica] × Petal Length  |                   |                     
#> Petal Width                         |                   |                     
#> ------------------------------------------------------------------------------
#> Observations                        |               150 |                  150
#> 
#>                  lm3 |                  lm4
#> -------------------------------------------
#>  4.21 ( 3.41,  5.02) |  4.21 ( 3.41,  5.02)
#> -1.81 (-2.99, -0.62) | -1.80 (-2.99, -0.62)
#> -3.15 (-4.41, -1.90) | -3.19 (-4.50, -1.88)
#>  0.54 ( 0.00,  1.09) |  0.54 (-0.02,  1.09)
#>  0.29 (-0.30,  0.87) |  0.28 (-0.30,  0.87)
#>  0.45 (-0.12,  1.03) |  0.45 (-0.12,  1.03)
#>                      |  0.03 (-0.28,  0.34)
#> -------------------------------------------
#>                  150 |                  150

^{Created on 2024-10-30 with reprex v2.1.1}

Desired

library(parameters)
data(iris)
lm1 <- lm(Sepal.Length ~ Species, data = iris)
lm2 <- lm(Sepal.Length ~ Species + Petal.Length, data = iris)
lm3 <- lm(Sepal.Length ~ Species * Petal.Length, data = iris)
lm4 <- lm(Sepal.Length ~ Species * Petal.Length + Petal.Width, data = iris)

tab <- compare_parameters(lm1, lm2, lm3, lm4)
print(tab, table_width = 80)
#> Parameter                           |               lm1 |                  lm2
#> ------------------------------------------------------------------------------
#> (Intercept)                         | 5.01 (4.86, 5.15) |  3.68 ( 3.47,  3.89)
#> Species [versicolor]                | 0.93 (0.73, 1.13) | -1.60 (-1.98, -1.22)
#> Species [virginica]                 | 1.58 (1.38, 1.79) | -2.12 (-2.66, -1.58)
#> Petal Length                        |                   |  0.90 ( 0.78,  1.03)
#> Species [versicolor] × Petal Length |                   |                     
#> Species [virginica] × Petal Length  |                   |                     
#> Petal Width                         |                   |                     
#> ------------------------------------------------------------------------------
#> Observations                        |               150 |                  150
#> 
#> Parameter                           |                  lm3 |                  lm4
#> ---------------------------------------------------------------------------------
#> (Intercept)                         |  4.21 ( 3.41,  5.02) |  4.21 ( 3.41,  5.02)
#> Species [versicolor]                | -1.81 (-2.99, -0.62) | -1.80 (-2.99, -0.62)
#> Species [virginica]                 | -3.15 (-4.41, -1.90) | -3.19 (-4.50, -1.88)
#> Petal Length                        |  0.54 ( 0.00,  1.09) |  0.54 (-0.02,  1.09)
#> Species [versicolor] × Petal Length |  0.29 (-0.30,  0.87) |  0.28 (-0.30,  0.87)
#> Species [virginica] × Petal Length  |  0.45 (-0.12,  1.03) |  0.45 (-0.12,  1.03)
#> Petal Width                         |                      |  0.03 (-0.28,  0.34)
#> ---------------------------------------------------------------------------------
#> Observations                        |                  150 |                  150

^{Created on 2024-10-30 with reprex v2.1.1}

mattansb · 2024-10-30T15:23:46Z

Was this working before?

strengejacke · 2024-10-30T17:16:00Z

Yes

strengejacke · 2024-10-30T19:26:33Z

See this code snippet from the original code:

      # copy first column, and all columns that did not fit into the first line
      # into the second table matrix
      if (i > 2 && i < ncol(final)) {
        final2 <- final[, c(1, i:ncol(final))]
        final <- final[, 1:(i - 1)]
      }

mattansb · 2024-10-30T19:37:29Z

Fixed

data(iris)

lm1 <- lm(Sepal.Length ~ Species, data = iris)
lm2 <- lm(Sepal.Length ~ Species + Petal.Length, data = iris)
lm3 <- lm(Sepal.Length ~ Species * Petal.Length, data = iris)
lm6 <- lm5 <- lm4 <- lm(Sepal.Length ~ Species * Petal.Length + Petal.Width, data = iris)

tab <- parameters::compare_parameters(lm1, lm2, lm3, lm4, lm5, lm6)

print(tab, table_width = 80)
#> Parameter                           |               lm1 |                  lm2
#> ------------------------------------------------------------------------------
#> (Intercept)                         | 5.01 (4.86, 5.15) |  3.68 ( 3.47,  3.89)
#> Species (versicolor)                | 0.93 (0.73, 1.13) | -1.60 (-1.98, -1.22)
#> Species (virginica)                 | 1.58 (1.38, 1.79) | -2.12 (-2.66, -1.58)
#> Petal Length                        |                   |  0.90 ( 0.78,  1.03)
#> Species (versicolor) × Petal Length |                   |                     
#> Species (virginica) × Petal Length  |                   |                     
#> Petal Width                         |                   |                     
#> ------------------------------------------------------------------------------
#> Observations                        |               150 |                  150
#> 
#> Parameter                           |                  lm3
#> ----------------------------------------------------------
#> (Intercept)                         |  4.21 ( 3.41,  5.02)
#> Species (versicolor)                | -1.81 (-2.99, -0.62)
#> Species (virginica)                 | -3.15 (-4.41, -1.90)
#> Petal Length                        |  0.54 ( 0.00,  1.09)
#> Species (versicolor) × Petal Length |  0.29 (-0.30,  0.87)
#> Species (virginica) × Petal Length  |  0.45 (-0.12,  1.03)
#> Petal Width                         |                     
#> ----------------------------------------------------------
#> Observations                        |                  150
#> 
#> Parameter                           |                  lm4
#> ----------------------------------------------------------
#> (Intercept)                         |  4.21 ( 3.41,  5.02)
#> Species (versicolor)                | -1.80 (-2.99, -0.62)
#> Species (virginica)                 | -3.19 (-4.50, -1.88)
#> Petal Length                        |  0.54 (-0.02,  1.09)
#> Species (versicolor) × Petal Length |  0.28 (-0.30,  0.87)
#> Species (virginica) × Petal Length  |  0.45 (-0.12,  1.03)
#> Petal Width                         |  0.03 (-0.28,  0.34)
#> ----------------------------------------------------------
#> Observations                        |                  150
#> 
#> Parameter                           |                  lm5 |                  lm6
#> ---------------------------------------------------------------------------------
#> (Intercept)                         |  4.21 ( 3.41,  5.02) |  4.21 ( 3.41,  5.02)
#> Species (versicolor)                | -1.80 (-2.99, -0.62) | -1.80 (-2.99, -0.62)
#> Species (virginica)                 | -3.19 (-4.50, -1.88) | -3.19 (-4.50, -1.88)
#> Petal Length                        |  0.54 (-0.02,  1.09) |  0.54 (-0.02,  1.09)
#> Species (versicolor) × Petal Length |  0.28 (-0.30,  0.87) |  0.28 (-0.30,  0.87)
#> Species (virginica) × Petal Length  |  0.45 (-0.12,  1.03) |  0.45 (-0.12,  1.03)
#> Petal Width                         |  0.03 (-0.28,  0.34) |  0.03 (-0.28,  0.34)
#> ---------------------------------------------------------------------------------
#> Observations                        |                  150 |                  150

^{Created on 2024-10-30 with reprex v2.1.1}

library(performance)

data(HolzingerSwineford1939, package = "lavaan")
structure <- " visual  =~ x1 + x2 + x3
               textual =~ x4 + x5 + x6
               speed   =~ x7 + x8 + x9 "
model1 <- lavaan::cfa(structure, data = HolzingerSwineford1939)
model2 <- lavaan::cfa(structure, data = HolzingerSwineford1939)

compare_performance(model1, model2) |> print(table_width = 50)
#> When comparing models, please note that probably not all models were fit
#>   from same data.
#> # Comparison of Model Performance Indices
#> 
#> Name   |  Model | Chi2(24) | p (Chi2)
#> -------------------------------------
#> model1 | lavaan |   85.306 |   < .001
#> model2 | lavaan |   85.306 |   < .001
#> 
#> Name   | Baseline(36) | p (Baseline) |   GFI
#> --------------------------------------------
#> model1 |      918.852 |       < .001 | 0.943
#> model2 |      918.852 |       < .001 | 0.943
#> 
#> Name   |  AGFI |   NFI |  NNFI |   CFI | RMSEA
#> ----------------------------------------------
#> model1 | 0.894 | 0.907 | 0.896 | 0.931 | 0.092
#> model2 | 0.894 | 0.907 | 0.896 | 0.931 | 0.092
#> 
#> Name   |    RMSEA  CI | p (RMSEA) |   RMR |  SRMR
#> -------------------------------------------------
#> model1 | [0.07, 0.11] |    < .001 | 0.082 | 0.065
#> model2 | [0.07, 0.11] |    < .001 | 0.082 | 0.065
#> 
#> Name   |   RFI |  PNFI |   IFI |   RNI
#> --------------------------------------
#> model1 | 0.861 | 0.605 | 0.931 | 0.931
#> model2 | 0.861 | 0.605 | 0.931 | 0.931
#> 
#> Name   | Loglikelihood |  AIC (weights)
#> ---------------------------------------
#> model1 |     -3737.745 | 7517.5 (0.500)
#> model2 |     -3737.745 | 7517.5 (0.500)
#> 
#> Name   |  BIC (weights) | BIC_adjusted
#> --------------------------------------
#> model1 | 7595.3 (0.500) |     7528.739
#> model2 | 7595.3 (0.500) |     7528.739

^{Created on 2024-10-30 with reprex v2.1.1}

strengejacke · 2024-11-01T09:37:46Z

I added some tests. Can be merged when all tests pass.

mattansb · 2024-11-01T11:40:55Z

How about setting "auto" to be the default... ;)

This reverts commit ced0fbf.

strengejacke · 2024-11-01T15:24:39Z

Let's change to "auto" in this PR, then check parameters with remotes to this PR and see how vignettes render? We have to make sure that everywhere, where we call export_table(), dots are passed to this function as well (so users can modify table_width).

mattansb · 2024-11-01T21:33:39Z

Alright, let's do it - we can see that everything is okay in parameters and then take care of the rest of the packages (there are currently 55 files that use this function across easystats).

Merging!

mattansb · 2024-11-01T21:39:25Z

It might be better if we have a global option for this, since looking at the various codes it might be difficult to pass ... all the way down to export_table().

option(easystats.table_width = 80)

# In the function

if (is.numeric(table_width)) {
  line_width <- table_width
} else {
  line_width <- getOption("easystats.table_width", default = getOption("width"))
}

test with changes introduced in easystats/insight#952

mattansb added 2 commits October 30, 2024 15:56

Update export_table.R

52b1ef6

minor fix

e0123df

strengejacke added 6 commits October 30, 2024 16:00

lintr

5d1a5c2

lintr

a41a721

lintr

4ef07d0

lintr

0385035

fix

4184378

version

e246d90

Merge branch 'main' into longer-export_table

522951a

always keep 1st col

d687920

strengejacke added 3 commits November 1, 2024 10:32

add tests

061e934

news, docs

9821313

lintr

ced0fbf

Revert "lintr"

4c1a8da

This reverts commit ced0fbf.

set default to "auto"

c3875ad

mattansb merged commit 410dc71 into main Nov 1, 2024
18 of 20 checks passed

mattansb deleted the longer-export_table branch November 1, 2024 21:33

mattansb added a commit to easystats/report that referenced this pull request Nov 3, 2024

Use dev insight

b124795

test with changes introduced in easystats/insight#952

mattansb added a commit to easystats/correlation that referenced this pull request Nov 3, 2024

Use dev insight

fced785

test with changes introduced in easystats/insight#952

mattansb added a commit to easystats/datawizard that referenced this pull request Nov 3, 2024

Use dev insight

5703d85

test with changes introduced in easystats/insight#952

mattansb added a commit to easystats/performance that referenced this pull request Nov 3, 2024

Use dev insight

5e4942e

test with changes introduced in easystats/insight#952

mattansb added a commit to easystats/see that referenced this pull request Nov 3, 2024

Use dev insight

4e7f923

test with changes introduced in easystats/insight#952

mattansb added a commit to easystats/effectsize that referenced this pull request Nov 3, 2024

Use dev insight

ff82079

test with changes introduced in easystats/insight#952

mattansb added a commit to easystats/bayestestR that referenced this pull request Nov 3, 2024

Use dev insight

8371cb8

test with changes introduced in easystats/insight#952

mattansb added a commit to easystats/modelbased that referenced this pull request Nov 3, 2024

Use dev insight

46fbc0d

test with changes introduced in easystats/insight#952

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow `export_table()` to split to more than 3 tables #952

Allow `export_table()` to split to more than 3 tables #952

mattansb commented Oct 30, 2024 •

edited

Loading

bwiernik commented Oct 30, 2024

strengejacke commented Oct 30, 2024

mattansb commented Oct 30, 2024

strengejacke commented Oct 30, 2024

strengejacke commented Oct 30, 2024

mattansb commented Oct 30, 2024

strengejacke commented Nov 1, 2024

mattansb commented Nov 1, 2024

strengejacke commented Nov 1, 2024

mattansb commented Nov 1, 2024

mattansb commented Nov 1, 2024

Allow export_table() to split to more than 3 tables #952

Allow export_table() to split to more than 3 tables #952

Conversation

mattansb commented Oct 30, 2024 • edited Loading

bwiernik commented Oct 30, 2024

strengejacke commented Oct 30, 2024

Current PR

Desired

mattansb commented Oct 30, 2024

strengejacke commented Oct 30, 2024

strengejacke commented Oct 30, 2024

mattansb commented Oct 30, 2024

strengejacke commented Nov 1, 2024

mattansb commented Nov 1, 2024

strengejacke commented Nov 1, 2024

mattansb commented Nov 1, 2024

mattansb commented Nov 1, 2024

Allow `export_table()` to split to more than 3 tables #952

Allow `export_table()` to split to more than 3 tables #952

mattansb commented Oct 30, 2024 •

edited

Loading