Learn R Programming

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

flextable R package

User Documentation: https://ardata-fr.github.io/flextable-book/

The flextable package provides a framework for easily create tables for reporting and publications. Tables can be easily formatted with a set of verbs such as bold(), color(), they can receive a header of more than one line, cells can be merged or contain an image. The package make it possible to build any table for publication from a `data.frame’.

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

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

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!

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

122,081

Version

0.6.5

License

GPL-3

Maintainer

David Gohel

Last Published

April 11th, 2021

Functions in flextable (0.6.5)

as_equation

equation chunk
align

Set text alignment
add_header_lines

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

chunk with values in brackets
as_flextable

method to convert object to flextable
add_header_row

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

Add rows in body part
as_b

bold chunk
as_chunk

chunk of text wrapper
add_header

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

tabular summary for gam object
as_flextable.grouped_data

tabular summary for grouped_data object
border_outer

set outer borders
border_remove

remove borders
compose

Define flextable displayed values
colorize

colorize chunk
border

Set cell borders
as_flextable.htest

tabular summary for htest object
colformat_date

format date cells
border_inner

set vertical & horizontal inner borders
autofit

Adjusts cell widths and heights
as_flextable.glm

tabular summary for glm object
bg

Set background color
colformat_int

format integer cells
fix_border_issues

fix border issues when cell are merged
as_grouped_data

grouped data transformation
colformat_lgl

format logical cells
flextable_dim

width and height of a flextable object
flextable

flextable creation
as_paragraph

concatenate chunks in a flextable
as_raster

get a flextable as a raster
as_highlight

highlight chunk
as_flextable.xtable

get a flextable from a xtable object
body_add_flextable

add flextable into a Word document
as_flextable.lm

tabular summary for lm object
flextable-package

flextable: Functions for Tabular Reporting
as_i

italic chunk
bold

Set bold font
get_flextable_defaults

Get flextable defaults formatting properties
colformat_double

format numeric cells
knit_print.flextable

Render flextable in rmarkdown
gg_chunk

gg plots chunk wrapper
colformat_datetime

format datetime cells
as_sub

subscript chunk
as_image

image chunk wrapper
as_sup

superscript chunk
chunk_dataframe

create a chunk representation suitable for flextable
dim_pretty

Calculate pretty dimensions
dim.flextable

Get widths and heights of flextable
colformat_char

format character cells
line_spacing

Set text alignment
continuous_summary

continuous columns summary
merge_h_range

rowwise merge of a range of columns
footers_flextable_at_bkm

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

format numeric cells
flextable_html_dependency

htmlDependency for flextable objects
colformat_image

format cells as images
flextable_to_rmd

flextable raw code
color

Set font color
border_inner_h

set inner borders
border_inner_v

set vertical inner borders
font

Set font
footnote

add footnotes to flextable
hrule

Set flextable rule for rows heights
highlight

Text Highlight Color
fp_border_default

Border formatting properties
delete_part

delete flextable part
fontsize

Set font size
hline_bottom

set bottom horizontal border
hline_top

set top horizontal border
merge_none

Delete flextable merging informations
hyperlink_text

chunk of text with hyperlink wrapper
hline

set horizontal borders
htmltools_value

flextable as an HTML object
italic

Set italic font
merge_v

Merge flextable cells vertically
fp_text_default

Text formatting properties
theme_booktabs

Apply booktabs theme
vline_left

set flextable left vertical borders
theme_alafoli

Apply alafoli theme
empty_blanks

make blank columns as transparent
vline_right

set flextable right vertical borders
lollipop

mini lollipop chart chunk wrapper
set_caption

Set Caption
linerange

mini linerange chunk wrapper
save_as_pptx

save flextable objects in an PowerPoint file
set_table_properties

Global table properties
merge_h

Merge flextable cells horizontally
merge_at

Merge flextable cells into a single one
print.flextable

flextable printing
theme_box

Apply box theme
proc_freq

frequency table as flextable
style

Set flextable style
theme_tron_legacy

Apply tron legacy theme
theme_vader

Apply Sith Lord Darth Vader theme
theme_tron

Apply tron theme
theme_zebra

Apply zebra theme
theme_vanilla

Apply vanilla theme
minibar

mini barplots chunk wrapper
fit_to_width

fit a flextable to a maximum width
nrow_part

Number of rows of a part
ncol_keys

Number of columns
plot.flextable

plot a flextable
headers_flextable_at_bkm

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

Set flextable rows height
ph_with.flextable

add a flextable into a PowerPoint slide
padding

Set paragraph paddings
save_as_image

save a flextable as an image
save_as_html

Save a Flextable in an HTML File
rotate

rotate cell text
plot_chunk

mini plots chunk wrapper
set_header_footer_df

Set flextable's header or footer rows
set_header_labels

Set flextable's headers labels
valign

Set vertical alignment
vline

set vertical borders
set_flextable_defaults

Modify flextable defaults formatting properties
void

Delete flextable content
save_as_docx

save flextable objects in an Word file
width

Set flextable columns width
set_formatter

set column formatter functions