Learn R Programming

⚠️There's a newer version (0.9.5) of this package.Take me there.

flextable R package

The user documentation is available here: https://ardata-fr.github.io/flextable-book/

set_flextable_defaults(
  font.family = "Arial", font.size = 10, 
  border.color = "gray")

flextable(head(cars)) %>% 
  bold(part = "header") %>% 
  add_footer_lines("The 'cars' dataset")

Tables can be embedded within HTML, PDF, Word and PowerPoint documents from R Markdown documents and within Microsoft Word or PowerPoint documents with package officer. Tables can also be rendered as R plots or graphic files (png, pdf and jpeg).

flextable(mtcars) %>% 
  theme_vanilla() %>% 
  save_as_docx(path = "mytable.docx")

A flextable object is a data.frame representation. An API is available to let R users create tables for reporting and control their formatting properties and their layout. The package provides functions that give control over:

  • header, body and footer content
  • text, paragraphs, cells and border formatting of any element
  • displayed values

Installation

install.packages("flextable")

You can get the development version from GitHub:

devtools::install_github("davidgohel/flextable")

Resources

Documentation

The help pages are in a bookdown located at: https://ardata-fr.github.io/flextable-book/

Manuals are available at: https://davidgohel.github.io/flextable/reference/index.html

A gallery of examples is available here: https://ardata.fr/en/flextable-gallery/

Getting help / questions

If you have questions about how to use the package, visit Stackoverflow and use tags flextable and r Stackoverflow link! You can also use https://github.com/davidgohel/flextable/discussions to start a discussion.

Contributing to the package

Code of Conduct

Anyone getting involved in this package agrees to our Code of Conduct.

Bug reports

When you file a bug report, please spend some time making it easy for me to follow and reproduce. The more time you spend on making the bug report coherent, the more time I can dedicate to investigate the bug as opposed to the bug report.

Contributing to the package development

A great way to start is to contribute an example or improve the documentation.

If you want to submit a Pull Request to integrate functions of yours, please provide:

  • the new function(s) with code and roxygen tags (with examples)
  • a new section in the appropriate vignette that describes how to use the new function
  • corresponding tests in directory tests/testthat.

By using rhub (run rhub::check_for_cran()), you will see if everything is ok. When submitted, the PR will be evaluated automatically on travis and appveyor and you will be able to see if something broke.

Copy Link

Version

Install

install.packages('flextable')

Monthly Downloads

82,872

Version

0.8.1

License

GPL-3

Maintainer

David Gohel

Last Published

September 19th, 2022

Functions in flextable (0.8.1)

add_body

Add column values as new lines in body
add_body_row

Add body labels
add_header_row

Add header labels
as_chunk

chunk of text wrapper
as_bracket

chunk with values in brackets
append_chunks

append chunks to flextable content
as_b

bold chunk
as_flextable

method to convert object to flextable
as_equation

equation chunk
as_flextable.grouped_data

tabular summary for grouped_data object
as_flextable.htest

tabular summary for htest object
as_i

italic chunk
as_grouped_data

grouped data transformation
as_flextable.gam

tabular summary for gam object
as_highlight

highlight chunk
as_image

image chunk wrapper
as_flextable.lm

tabular summary for lm object
as_flextable.kmeans

tabular summary for kmeans
as_sup

superscript chunk
as_sub

subscript chunk
as_paragraph

concatenate chunks in a flextable
as_raster

get a flextable as a raster
colformat_char

format character cells
as_flextable.glm

tabular summary for glm object
colformat_date

format date cells
as_flextable.merMod

tabular summary for mixed model
chunk_dataframe

create a chunk representation suitable for flextable
colformat_datetime

format datetime cells
continuous_summary

continuous columns summary
as_word_field

'Word' computed field
colformat_num

format numeric cells
as_flextable.tabulator

tabulator to flextable
as_flextable.xtable

get a flextable from a xtable object
fix_border_issues

fix border issues when cell are merged
before

is an element before a match with entries
as_flextable.pam

tabular summary for pam
colorize

colorize chunk
color

Set font color
delete_part

delete flextable part
df_printer

data.frame automatic printing as a flextable
bg

Set background color
compose

Define displayed values and mixed content
border

cell borders update
dim.flextable

Get widths and heights of flextable
flextable

flextable creation
flextable_dim

width and height of a flextable object
border_inner

set vertical & horizontal inner borders
flextable-package

flextable: Functions for Tabular Reporting
fmt_2stats

format content for data generated with summarizor()
flextable_to_rmd

flextable raw code
body_add_flextable

add flextable into a Word document
font

Set font
flextable_html_dependency

htmlDependency for flextable objects
bold

Set bold font
hrule

Set flextable rule for rows heights
get_flextable_defaults

Get flextable defaults formatting properties
headers_flextable_at_bkm

add flextable at a bookmark location in document's header
border_outer

set outer borders
border_remove

remove borders
height

Set flextable rows height
gg_chunk

gg plots chunk wrapper
htmltools_value

flextable as an HTML object
line_spacing

Set text alignment
footnote

add footnotes to flextable
border_inner_v

set vertical inner borders
merge_h

Merge flextable cells horizontally
merge_h_range

rowwise merge of a range of columns
linerange

mini linerange chunk wrapper
autofit

Adjusts cell widths and heights
ph_with.flextable

add a flextable into a PowerPoint slide
colformat_double

format numeric cells
border_inner_h

set inner borders
colformat_lgl

format logical cells
plot.flextable

plot a flextable
nrow_part

Number of rows of a part
fp_border_default

Border formatting properties
save_as_pptx

save flextable objects in an PowerPoint file
colformat_int

format integer cells
dim.flextableGrob

Get optimal width and height of a flextable grob
padding

Set paragraph paddings
save_as_image

save a flextable as an image
save_as_html

Save a Flextable in an HTML File
merge_at

Merge flextable cells into a single one
lollipop

mini lollipop chart chunk wrapper
summarizor

data summary preparation
dim_pretty

Calculate pretty dimensions
set_formatter

set column formatter functions
fp_text_default

Text formatting properties
merge_none

Delete flextable merging informations
merge_v

Merge flextable cells vertically
set_header_footer_df

Set flextable's header or footer rows
separate_header

Separate collapsed colnames into multiple rows
surround

Set borders for a selection of cells
set_header_labels

Change headers labels
set_table_properties

Global table properties
colformat_image

format cells as images
tabulator

Tabulation of aggregations
theme_zebra

Apply zebra theme
tabulator_colnames

column keys of tabulator objects
use_df_printer

set data.frame automatic printing as a flextable
prepend_chunks

prepend chunks to flextable content
theme_tron

Apply tron theme
fit_to_width

fit a flextable to a maximum width
empty_blanks

make blank columns as transparent
print.flextable

flextable printing
theme_booktabs

Apply booktabs theme
hline_bottom

set bottom horizontal border
gen_grob

Convert a flextable to a grid grob object
fontsize

Set font size
vline_right

set flextable right vertical borders
footers_flextable_at_bkm

add flextable at a bookmark location in document's footer
theme_tron_legacy

Apply tron legacy theme
highlight

Text highlight color
hline_top

set top horizontal border
void

Delete flextable content
shift_table

Create a shift table
style

Set flextable style
hline

set horizontal borders
hyperlink_text

Chunk of text with hyperlink
italic

Set italic font
theme_box

Apply box theme
theme_vader

Apply Sith Lord Darth Vader theme
valign

Set vertical alignment
minibar

mini barplots chunk wrapper
vline

set vertical borders
use_model_printer

set model automatic printing as a flextable
theme_vanilla

Apply vanilla theme
knit_print.flextable

Render flextable in rmarkdown
ncol_keys

Number of columns
proc_freq

frequency table as flextable
set_caption

Set Caption
regulartable

flextable old functions
set_flextable_defaults

Modify flextable defaults formatting properties
vline_left

set flextable left vertical borders
theme_alafoli

Apply alafoli theme
plot.flextableGrob

plot a flextable grob
labelizor

change displayed labels
theme_apa

Apply APA theme
width

Set columns width
plot_chunk

mini plots chunk wrapper
save_as_docx

save flextable objects in an Word file
rotate

rotate cell text
add_latex_dep

add latex dependencies
add_header_lines

Add labels as new rows in the header
add_footer

Add column values as new lines in footer
add_footer_row

Add footer labels
add_header

Add column values as new lines in header
align

Set text alignment
add_footer_lines

Add labels as new rows in the footer