flextable
Functions for Tabular Reporting
Create pretty tables for 'HTML', 'PDF', 'Microsoft Word' and 'Microsoft PowerPoint' documents from 'R Markdown'. Functions are provided to let users create tables, modify and format their content. It also extends package 'officer' that does not contain any feature for customized tabular reporting.
The flextable package provides a framework for easily create tables for reporting. Tables can be embedded within:
- R Markdown documents with support for HTML, Word and PowerPoint documents.
- Microsoft Word or PowerPoint documents.
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.
News
flextable 0.5.1
Issues
- fix issue with font colors in powerpoint
- fix issues with colors for Windows RStudio viewer
new features
- new themes functions
theme_alafoli()andtheme_vader() - new functions
align_text_col()andalign_nottext_col()to align columns by data type - new functions
merge_h_range()to merge a set of columns row by row - new functions
fix_border_issues()fix issues with borders when cells are merged - new functions
add_header_row(),add_footer_row(),add_header_lines()andadd_footer_lines()to add easily data in header or footer. - new generic function
as_flextable()to let develop new flextable functions - new function
as_grouped_data()and its methodas_flextable()to create row titles to separate data in a flextable.
flextable 0.5.0
Improvement
- new arguments
valuesfor functionsset_header_labelsandset_formatter - styles functions now support injection of more than a single value
- this version a big refactoring and got rid of R6
new features
- new function
composethat will replacedisplay - new function
set_captiononly available for html output
flextable 0.4.7
new features
knit_print()can be used with rmarkdown when rendering to PowerPoint.
Issues
- fix issue with
regulartableand logical columns
flextable 0.4.6
new features
- a new helper function
body_replace_flextable_at_bkmto replace a bookmarked paragraph by a flextable. - new functions
colformat_*to make content formatting easier. It also deals with NA.
Improvement
- Documentation
format.flextablemethod so that users can create their components. - new knitr chunk options
ft.alignto align tables inrmarkdown::word_documentandft.splitto activate Word option 'Allow row to break across pages'.
Issues
- fix issue (unordered and duplicated chunk of text) in function
display()
flextable 0.4.5
Improvement
- flextable will not be split across rows at a page break in Word documents.
Issues
- fix border rendering with
vline() - empty data.frame are no more generating an error
flextable 0.4.4
new features
- Soft return
\nis now supported. Functionautofitanddim_prettydo not support soft returns and may return wrong results (\n will be considered as ""). - format function for flextable objects.
Issues
- fix border rendering with
border_outer()
flextable 0.4.3
new features
- new functions:
hyperlink_text()to be used withdisplay,font() - new functions
hline*()andvline*()and many new helper functions to be used instead of borders.
Improvement
- manuals have been refactored
Issues
- fix display issue when a cell was containing NA
flextable 0.4.2
new features
- new function
xtable_to_flextable()that is returning a flextable from an xtable object. - function
htmltools_value()is exported for shiny applications.
flextable 0.4.1
new features
- flextables have now a footer part
flextable 0.4.0
new features
- new function
knit_print()to render flextable in rmarkdown.
Changes
- function tabwid() is deprecated in favor of a knit_print implementation.
- list of dependencies has been reduced.
flextable 0.3
new features
- new function
regulartable, faster and simpler thanflextable
Issues
- characters <, > and & are now html encoded
- fix columns widths when output format is HTML
flextable 0.2
new features
- new function
ph_with_flextable_atto add a flextable at any position in a slide. - new function
merge_atis providing a general way of merging cells. - new theme function:
theme_box()
Changes
- function display() now works with a mustache template
Issues
- fix fontsize when part == "all"