Chapter 1 Overview

The flextable package provides a framework for easily create tables for reporting and publications. Functions are provided to let users create tables, modify and format their content and define their content.

Tables can be embedded within:

  • R Markdown documents with support for HTML, Word, PDF and PowerPoint documents.
  • Microsoft Word or PowerPoint documents with package officer.

Tables can also be rendered as R plots or graphic files (png, pdf and jpeg).

1.1 Introduction

flextable can easily create reporting table from data.frame. You can merge cells, add header rows, add footer rows, change any format and specify how data should be displayed in cells. Tables content can also contain mixed type of content, text and images.

flextable objects can be rendered in HTML format, Microsoft Word, Microsoft PowerPoint and PDF.

The following table is an example of a flextable rendered in HTML.

ft <- flextable(airquality[ sample.int(10),])
ft <- add_header_row(ft,
  colwidths = c(4, 2),
  values = c("Air quality", "Time")
)
ft <- theme_vanilla(ft)
ft <- add_footer_lines(ft, "Daily air quality measurements in New York, May to September 1973.")
ft <- color(ft, part = "footer", color = "#666666")
ft <- set_caption(ft, caption = "New York Air Quality Measurements")
ft

The main function is flextable. Call the function with a data.frame as argument. If you are using RStudio or another R GUI, the table will be displayed in the Viewer panel or in your default browser.

flextable(world_phones)

The function is using default values to format the table. It is also using a simple formatting function to create the paragraphs of text that will be rendered in each cell. If you want to change the default appearance of the tables, you can use the set_flextable_defaults function.

set_flextable_defaults(big.mark = " ", 
  font.size = 10, theme_fun = theme_vanilla,
  padding.bottom = 6, 
  padding.top = 6,
  padding.left = 6,
  padding.right = 6,
  background.color = "#EFEFEF")
flextable(world_phones)

1.2 Other ressources

1.2.1 Function reference

Function reference (manuals) is available here: https://davidgohel.github.io/flextable/reference/index.html

These manuals are also available when using R as usual help pages.

1.2.3 Cheat sheet

A cheat sheet has been written by Clémentine Jager and available here: Flextable cheat sheet

1.3 Walkthrough: simple example

flextable has been designed to allow the construction of more complex tables. A set of functions will allow you to change colors, fonts, add headers and many other things to give you the possibility to build the tables that fit your needs.

Let’s have a step by step simple demo.

1.3.1 Creation

myft <- flextable(head(mtcars), 
  col_keys = c("am", "carb", "gear", "mpg", "drat" ))
myft

Optional argument col_keys is used to only display a subset of columns.

1.3.2 Formatting

Many sugar functions can be used to format flextables: bg(), fontsize(), italic(), bold(), color(), padding()

Conditional formatting can be made by using the selector arguments. All formatting functions are accepting selector arguments.

myft <- italic(myft, j = 3)
myft <- color(myft, ~ drat > 3.5, ~ drat, color = "red")
myft <- bold(myft, ~ drat > 3.5, ~ drat, bold = TRUE)
myft

1.3.3 Layout

Table layout can be modified. One can add or change header/footer rows, change cells height and width and merge cells.

myft <- add_header_row(
  x = myft, values = c("some measures", "other measures"),
  colwidths = c(3, 2))
myft <- align(myft, i = 1, part = "header", align = "center")
myft

1.3.4 Theme

Functions theme_ are sugar functions whose role is to apply a set of formatting instructions to a flextable.

myft <- theme_vanilla(myft)
myft