⚠️There's a newer version (0.9.5) 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

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

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

52,380

Version

0.7.0

License

GPL-3

Maintainer

Last Published

March 6th, 2022

Functions in flextable (0.7.0)

add_latex_dep

add latex dependencies
append_chunks

append chunks to flextable content
add_header

Add a rows of labels in header or footer part
align

Set text alignment
as_bracket

chunk with values in brackets
add_body

Add rows in body part
as_b

bold chunk
add_header_row

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

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

chunk of text wrapper
as_flextable.grouped_data

tabular summary for grouped_data object
as_flextable.lm

tabular summary for lm object
as_flextable.tabulator

tabulator to flextable
before

is an element before a match with entries
bg

Set background color
as_flextable.xtable

get a flextable from a xtable object
as_grouped_data

grouped data transformation
as_highlight

highlight chunk
as_i

italic chunk
as_sub

subscript chunk
as_raster

get a flextable as a raster
as_flextable.gam

tabular summary for gam object
as_flextable.glm

tabular summary for glm object
border

cell borders update
as_equation

equation chunk
border_inner

set vertical & horizontal inner borders
border_remove

remove borders
border_outer

set outer borders
as_flextable

method to convert object to flextable
border_inner_v

set vertical inner borders
as_paragraph

concatenate chunks in a flextable
border_inner_h

set inner borders
as_image

image chunk wrapper
as_flextable.htest

tabular summary for htest object
autofit

Adjusts cell widths and heights
as_sup

superscript chunk
body_add_flextable

add flextable into a Word document
colformat_int

format integer cells
colformat_date

format date cells
bold

Set bold font
colformat_double

format numeric cells
fit_to_width

fit a flextable to a maximum width
fix_border_issues

fix border issues when cell are merged
colformat_lgl

format logical cells
continuous_summary

continuous columns summary
font

Set font
colformat_image

format cells as images
fontsize

Set font size
delete_part

delete flextable part
colformat_char

format character cells
chunk_dataframe

create a chunk representation suitable for flextable
flextable_dim

width and height of a flextable object
color

Set font color
colformat_num

format numeric cells
colorize

colorize chunk
colformat_datetime

format datetime cells
hrule

Set flextable rule for rows heights
flextable_html_dependency

htmlDependency for flextable objects
dim.flextable

Get widths and heights of flextable
fp_text_default

Text formatting properties
fp_border_default

Border formatting properties
df_printer

data.frame automatic printing as a flextable
flextable_to_rmd

flextable raw code
flextable

flextable creation
flextable-package

flextable: Functions for Tabular Reporting
fmt_2stats

compose

Define flextable displayed values
get_flextable_defaults

Get flextable defaults formatting properties
dim_pretty

Calculate pretty dimensions
htmltools_value

flextable as an HTML object
highlight

Text Highlight Color
linerange

mini linerange chunk wrapper
lollipop

mini lollipop chart chunk wrapper
hline

set horizontal borders
gg_chunk

gg plots chunk wrapper
empty_blanks

make blank columns as transparent
headers_flextable_at_bkm

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

plot a flextable
plot_chunk

mini plots chunk wrapper
merge_h_range

rowwise merge of a range of columns
footers_flextable_at_bkm

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

set bottom horizontal border
footnote

add footnotes to flextable
merge_none

Delete flextable merging informations
hline_top

set top horizontal border
padding

Set paragraph paddings
knit_print.flextable

Render flextable in rmarkdown
line_spacing

Set text alignment
save_as_html

Save a Flextable in an HTML File
merge_h

Merge flextable cells horizontally
save_as_image

save a flextable as an image
ncol_keys

Number of columns
height

Set flextable rows height
merge_at

Merge flextable cells into a single one
nrow_part

Number of rows of a part
save_as_pptx

save flextable objects in an PowerPoint file
theme_booktabs

Apply booktabs theme
ph_with.flextable

add a flextable into a PowerPoint slide
theme_box

Apply box theme
set_caption

Set Caption
print.flextable

flextable printing
italic

Set italic font
hyperlink_text

chunk of text with hyperlink wrapper
proc_freq

frequency table as flextable
summarizor

data summary preparation
set_flextable_defaults

Modify flextable defaults formatting properties
set_formatter

set column formatter functions
set_header_footer_df

Set flextable's header or footer rows
surround

Set borders for a selection of cells
set_header_labels

Set flextable's headers labels
theme_vader

Apply Sith Lord Darth Vader theme
theme_vanilla

Apply vanilla theme
width

Set flextable columns width
theme_tron

Apply tron theme
void

Delete flextable content
merge_v

Merge flextable cells vertically
minibar

mini barplots chunk wrapper
rotate

rotate cell text
save_as_docx

save flextable objects in an Word file
set_table_properties

Global table properties
style

Set flextable style
theme_alafoli

Apply alafoli theme
tabulator

Tabulation of aggregations
theme_tron_legacy

Apply tron legacy theme
theme_zebra

Apply zebra theme
use_df_printer

set data.frame automatic printing as a flextable
vline_left

set flextable left vertical borders
vline

set vertical borders
valign

Set vertical alignment
vline_right

set flextable right vertical borders