Learn R Programming

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

flextable R package

. The flextable package provides a framework for easily create tables for reporting and publications. Tables can be embedded within:

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

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

Documentation: https://davidgohel.github.io/flextable/

Getting Started

An API is available to let R users create tables for reporting and control their formatting properties and their layout. A flextable object is a data.frame representation, it can be manipulated with functions that give control over:

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

There are articles on the flextable website that will help you get you to start quickly:

The help pages can be read here.

Installation

install.packages("flextable")

You can get the development version from GitHub:

devtools::install_github("davidgohel/flextable")

Resources

Online documentation

The help pages are located at https://davidgohel.github.io/flextable/.

Getting help

This project is developed and maintained on my own time. If you have questions about how to use the package, visit Stackoverflow and use tags flextable and r Stackoverflow link! I usually read them and answer when possible.

Don’t send me a private emails to get free R support or to ask questions about using the package. They are systematically ignored except if you are French in which case I send you a commercial proposal :)

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

74,548

Version

0.5.11

License

GPL-3

Maintainer

David Gohel

Last Published

September 9th, 2020

Functions in flextable (0.5.11)

add_header

Add a rows of labels in header or footer part
as_flextable.glm

tabular summary for glm object
as_flextable

method to convert object to flextable
add_header_row

Add labels and merge cells in a new header or footer row
as_bracket

chunk with values in brackets
as_chunk

chunk of text wrapper
as_b

bold chunk
add_header_lines

Add a label in a header or footer new row.
as_flextable.grouped_data

tabular summary for grouped_data object
as_flextable.xtable

get a flextable from a xtable object
as_sub

subscript chunk
align

Set text alignment
as_flextable.htest

tabular summary for htest object
as_paragraph

concatenate chunks in a flextable
border_inner_h

set inner borders
flextable

flextable creation
colformat_num

format numeric cells
border_inner_v

set vertical inner borders
flextable_dim

width and height of a flextable object
as_raster

get a flextable as a raster
colformat_lgl

format logical cells
as_sup

superscript chunk
merge_h_range

rowwise merge of a range of columns
as_flextable.lm

tabular summary for lm object
as_i

italic chunk
bold

Set bold font
delete_part

delete flextable part
body_add_flextable

add flextable into a Word document
continuous_summary

continuous columns summary
color

Set font color
autofit

Adjusts cell widths and heights
compose

Define flextable displayed values
bg

Set background color
fontsize

Set font size
footers_flextable_at_bkm

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

Delete flextable merging informations
linerange

mini linerange chunk wrapper
save_as_html

Save a Flextable in an HTML File
as_image

image chunk wrapper
save_as_image

save a flextable as an image
border

Set cell borders
colformat_char

format character cells
colformat_int

format integer cells
as_grouped_data

grouped data transformation
border_inner

set vertical & horizontal inner borders
dim.flextable

Get widths and heights of flextable
border_outer

set outer borders
border_remove

remove borders
fit_to_width

fit a flextable to a maximum width
dim_pretty

Calculate pretty dimensions
lollipop

mini lollipop chart chunk wrapper
theme_booktabs

Apply booktabs theme
theme_box

Apply box theme
hyperlink_text

chunk of text with hyperlink wrapper
fix_border_issues

fix border issues when cell are merged
headers_flextable_at_bkm

add flextable at a bookmark location in document's header
ph_with.flextable

add a flextable into a PowerPoint slide
padding

Set paragraph paddings
footnote

add footnotes to flextable
italic

Set italic font
save_as_pptx

save flextable objects in an PowerPoint file
flextable-defunct

Defunct Functions in Package flextable
flextable_html_dependency

htmlDependency for flextable objects
docx_value

flextable Office Open XML string for Word
vline

set vertical borders
vline_left

set flextable left vertical borders
set_caption

set caption
hrule

Set flextable rule for rows heights
ph_with_flextable

add flextable into a PowerPoint slide
plot.flextable

plot a flextable
htmltools_value

flextable as a div object
flextable-package

flextable: Functions for Tabular Reporting
empty_blanks

make blank columns as transparent
print.flextable

flextable printing
hline_bottom

set bottom horizontal border
hline_top

set top horizontal border
theme_tron

Apply tron theme
merge_at

Merge flextable cells into a single one
proc_freq

frequency table as flextable
merge_v

Merge flextable cells vertically
set_header_labels

Set flextable's headers labels
merge_h

Merge flextable cells horizontally
minibar

mini barplots chunk wrapper
set_formatter

set column formatter functions
theme_tron_legacy

Apply tron legacy theme
width

Set flextable columns width
set_table_properties

Global table properties
height

Set flextable rows height
font

Set font
theme_zebra

Apply zebra theme
valign

Set vertical alignment
set_header_footer_df

Set flextable's header or footer rows
hline

set horizontal borders
knit_print.flextable

Render flextable in rmarkdown
rotate

rotate cell text
line_spacing

Set text alignment
save_as_docx

save flextable objects in an Word file
style

Set flextable style
theme_vader

Apply Sith Lord Darth Vader
theme_alafoli

Apply alafoli theme
theme_vanilla

Apply vanilla theme
vline_right

set flextable right vertical borders
void

Delete flextable content