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.
  • PDF documents with package pagedown (it’s only HTML)

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

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")

Ressources

Online documentation

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

Getting help

This project is developped 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.

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,252

Version

0.5.5

License

GPL-3

Maintainer

David Gohel

Last Published

June 25th, 2019

Functions in flextable (0.5.5)

headers_flextable_at_bkm

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

concatenate chunks in a flextable
as_image

image chunk wrapper
bg

Set background color
as_i

italic chunk
as_sub

subscript chunk
border_inner

set vertical & horizontal inner borders
as_raster

get a flextable as a raster
color

Set font color
border_inner_h

set inner borders
body_add_flextable

add flextable into a Word document
compose

Define flextable displayed values
autofit

Adjusts cell widths and heights
colformat_int

format integer cells
colformat_char

format character cells
as_sup

superscript chunk
colformat_lgl

format logical cells
border

Set cell borders
bold

Set bold font
border_remove

remove borders
delete_part

delete flextable part
dim.flextable

Get widths and heights of flextable
flextable_dim

width and height of a flextable object
font

Set font
height

Set flextable rows height
italic

Set italic font
knit_print.flextable

Render flextable in rmarkdown
ph_with.flextable

add a flextable into a PowerPoint slide
flextable-package

flextable: Functions for Tabular Reporting
colformat_num

format numeric cells
docx_value

flextable docx string
htmltools_value

flextable as a div object
flextable

flextable creation
hyperlink_text

chunk of text with hyperlink wrapper
proc_freq

frequency table as flextable
hline

set horizontal borders
border_outer

set outer borders
border_inner_v

set vertical inner borders
xtable_to_flextable

get a flextable from a xtable object
rotate

rotate cell text
void

Delete flextable content
vline_right

set flextable right vertical borders
width

Set flextable columns width
ph_with_flextable

add flextable into a PowerPoint slide
fit_to_width

fit a flextable to a maximum width
style

Set flextable style
display

Define flextable displayed values
dim_pretty

Calculate pretty dimensions
empty_blanks

make blank columns as transparent
set_formatter

set column formatter functions
merge_none

Delete flextable merging informations
merge_v

Merge flextable cells vertically
set_caption

set caption
fix_border_issues

fix border issues when cell are merged
fontsize

Set font size
footnote

add footnotes to flextable
footers_flextable_at_bkm

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

Apply zebra theme
theme_alafoli

Apply box theme
format.flextable

Encode flextable in a document format.
linerange

mini linerange chunk wrapper
merge_at

Merge flextable cells into a single one
valign

Set vertical alignment
vline

set vertical borders
hline_top

set top horizontal border
hline_bottom

set bottom horizontal border
padding

Set paragraph paddings
minibar

mini barplots chunk wrapper
vline_left

set flextable left vertical borders
merge_h

Merge flextable cells horizontally
save_as_html

save a flextable in an HTML file
plot.flextable

plot a flextable
merge_h_range

rowwise merge of a range of columns
print.flextable

flextable printing
theme_booktabs

Apply booktabs theme
theme_box

Apply box theme
save_as_image

save a flextable as an image
theme_vader

Apply Sith Lord Darth Vader
set_header_footer_df

Set flextable's header or footer rows
theme_vanilla

Apply vanilla theme
set_header_labels

Set flextable's headers labels
theme_tron_legacy

Apply tron legacy theme
theme_tron

Apply tron theme
add_header_lines

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

method to convert object to flextable
align

Set text alignment
as_b

bold chunk
add_header

Add a rows of labels in header or footer part
as_chunk

chunk of text wrapper
as_grouped_data

grouped data transformation
as_bracket

chunk with values in brackets
add_header_row

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