Table layout

vertical merging

merge_v will merge adjacent duplicated cells for each column of the selection.

select_columns <- c("Species", "Petal.Length", "Petal.Width")
myft <- regulartable(iris[46:55,], col_keys = select_columns)
myft <- merge_v(myft, ~ Species + Petal.Width )
myft

horizontal merging

merge_h will merge adjacent duplicated cells for each row of the selection.

select_columns <- c("Species", "Petal.Length", "Petal.Width")
myft <- regulartable(head(mtcars, n = 10 ) )
myft <- merge_h(myft)
# and add borders
myft <- border(myft, border = fp_border(), part = "all") 
myft

general merging function

select_columns <- c("Species", "Petal.Length", "Petal.Width")
myft <- regulartable(head(mtcars, n = 6 ) )
myft <- merge_at( myft, i = 1:3, j = 1:3)
myft <- border(myft, border = fp_border(), part = "all")
myft

delete merging informations

If you want to get rid of all merging (i.e. for development purposes), use merge_none:

merge_none(myft)

col_keys

Parameter col_keys define the variables to display and their order.

data <- iris[c(1:3, 51:53, 101:104),]

myft <- regulartable(data, col_keys = c("Species", "Sepal.Length", "Petal.Length") )
theme_booktabs(myft) 

If parameter col_keys has variables that are not existing in the dataset, they will be considered as blank columns and can be used as separators (in fact they can be use as you want, there is only no mapping of data associated).

myft <- regulartable(
  data = data, 
  col_keys = c("Species", "col_1", "Sepal.Length", "Petal.Length") )
myft <- theme_vanilla(myft)
myft <- autofit(myft)
myft <- border(myft, j = 2, 
               border = fp_border(width=0), part = "all") 

col_keys default values are the names of the data.frame used to fill the flextable.

Change labels

Use set_header_labels to replace labels of the bottom row of header.

ft <- regulartable( head( iris ) ) 
ft <- set_header_labels(ft, Sepal.Length = "Sepal", 
    Sepal.Width = "Sepal", Petal.Length = "Petal",
    Petal.Width = "Petal", Species = "Species" )
ft <- theme_vanilla(ft)
ft <- autofit(ft)
ft

add a row of labels

Use add_header to add an header row.

ft <- add_header(ft, Sepal.Length = "length",
    Sepal.Width = "width", Petal.Length = "length",
    Petal.Width = "width", Species = "Species", top = FALSE ) 
ft <- theme_vanilla(ft)
ft <- autofit(ft)
ft

ft <- add_header(ft, Sepal.Length = "Inches",
    Sepal.Width = "Inches", Petal.Length = "Inches",
    Petal.Width = "Inches", Species = "Species", top = TRUE )

# merge identical cells
ft <- merge_h(ft, part = "header")
ft <- merge_v(ft, part = "header")

ft <- theme_vanilla(ft)
ft <- autofit(ft)
ft

Define headers with a reference table

Use set_header_df with a data.frame as parameter. Columns of the dataset will be transposed and joined using a key column.

typology <- data.frame(
  col_keys = c( "Sepal.Length", "Sepal.Width", "Petal.Length",
                "Petal.Width", "Species" ),
  type = c("double", "double", "double", "double", "factor"),
  what = c("Sepal", "Sepal", "Petal", "Petal", "Species"),
  measure = c("Length", "Width", "Length", "Width", "Species"),
  stringsAsFactors = FALSE )
autofit( theme_vanilla(flextable(typology)) )

ft <- regulartable( head( iris ) )
ft <- set_header_df( ft, mapping = typology, key = "col_keys" )

ft <- merge_h(ft, part = "header")
ft <- merge_v(ft, part = "header")

ft <- theme_vanilla(ft)
ft <- autofit(ft)
ft

Pretty dimensions

Function dim_pretty is computing optimized widths and heights.

dim_pretty(ft_base)
#> $widths
#> [1] 0.9460630 0.8688196 0.9074752 0.8302318 0.5991121
#> 
#> $heights
#> [1] 0.2044180 0.1756637 0.1756637 0.1756637 0.1756637 0.1756637 0.1756637

Adjusts automatically cell widths and heights

Function autofit optimises widths and heights of the flextable. This function is almost always to be called once when using flextable objects, it makes compact tables.

ft <- autofit(ft_base, add_w = 0, add_h = 0)

dim(ft)
#> $widths
#> Sepal.Length  Sepal.Width Petal.Length  Petal.Width      Species 
#>    0.9460630    0.8688196    0.9074752    0.8302318    0.5991121 
#> 
#> $heights
#> [1] 0.2044180 0.1756637 0.1756637 0.1756637 0.1756637 0.1756637 0.1756637
ft

Adjusts manually cell widths and heights

Function width() and height() let you control dimensions of a flextable. height_all() is an helper function to set the same height to each part of the table.

ft <- autofit(ft_base)
ft <- width(ft, j = ~ Species, width = 2)
ft <- height_all( ft, height = .4 )
ft <- height( ft, i = 3, height = 1 )
ft