R: Functions for Tabular Reporting

# Functions for Tabular Reporting

## Documentation for package ‘flextable’ version 0.9.12

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Package NEWS.

## Help Pages

A B C D E F G H I K L M N P Q R S T U V W

flextable-package | flextable: Functions for Tabular Reporting

## -- A --

add_body | Add body rows with one value per column
add_body_row | Add a body row with spanning labels
add_footer | Add footer rows with one value per column
add_footer_lines | Add full-width rows to the footer
add_footer_row | Add a footer row with spanning labels
add_header | Add header rows with one value per column
add_header_lines | Add full-width rows to the header
add_header_row | Add a header row with spanning labels
align | Set text alignment
align_nottext_col | Set text alignment
align_text_col | Set text alignment
append_chunks | Append chunks to flextable content
as_b | Bold chunk
as_bracket | Bracket chunk
as_chunk | Text chunk
as_equation | Equation chunk
as_flextable | Method to transform objects into flextables
as_flextable.brmsfit | Transform a 'merMod' or 'lme' object into a flextable
as_flextable.compact_summary | Transform a 'compact_summary' object into a flextable
as_flextable.data.frame | Transform and summarise a 'data.frame' into a flextable Simple summary of a data.frame as a flextable
as_flextable.ElementaryTable | Transform an rtables object into a flextable
as_flextable.gam | Transform a 'gam' model into a flextable
as_flextable.glm | Transform a 'glm' object into a flextable
as_flextable.glmmadmb | Transform a 'merMod' or 'lme' object into a flextable
as_flextable.glmmTMB | Transform a 'merMod' or 'lme' object into a flextable
as_flextable.gls | Transform a 'merMod' or 'lme' object into a flextable
as_flextable.grouped_data | Transform a 'grouped_data' object into a flextable
as_flextable.htest | Transform a 'htest' object into a flextable
as_flextable.kmeans | Transform a 'kmeans' object into a flextable
as_flextable.lm | Transform a 'lm' object into a flextable
as_flextable.lme | Transform a 'merMod' or 'lme' object into a flextable
as_flextable.merMod | Transform a 'merMod' or 'lme' object into a flextable
as_flextable.nlme | Transform a 'merMod' or 'lme' object into a flextable
as_flextable.pam | Transform a 'pam' object into a flextable
as_flextable.summarizor | Transform a 'summarizor' object into a flextable
as_flextable.table | Transform a 'table' object into a flextable
as_flextable.TableTree | Transform an rtables object into a flextable
as_flextable.tabular | Transform a 'tables::tabular' object into a flextable
as_flextable.tabulator | Transform a 'tabulator' object into a flextable
as_flextable.xtable | Transform a 'xtable' object into a flextable
as_grouped_data | Insert group-label rows into a data frame
as_highlight | Highlight chunk
as_i | Italic chunk
as_image | Image chunk
as_paragraph | Build a paragraph from chunks
as_qmd | Quarto inline markdown chunk
as_strike | Strikethrough chunk
as_sub | Subscript chunk
as_sup | Superscript chunk
as_word_field | Word dynamic field chunk
autofit | Adjust columns to their content size

## -- B --

before | Detect rows before a given value
bg | Set background color
body_add_flextable | Add flextable into a Word document
body_replace_flextable_at_bkm | Add flextable at bookmark location in a Word document
bold | Set bold font
border_inner | Set all inner borders
border_inner_h | Set inner horizontal borders
border_inner_v | Set inner vertical borders
border_outer | Set outer borders
border_remove | Remove borders

## -- C --

colformat_char | Format character cells
colformat_date | Format date cells
colformat_datetime | Format datetime cells
colformat_double | Format double cells
colformat_image | Format cells as images
colformat_int | Format integer cells
colformat_lgl | Format logical cells
colformat_num | Format numeric cells with format()
color | Set font color
colorize | Colorize chunk
compact_summary | Compact Summary of a Dataset
compose | Set cell content from paragraph chunks
continuous_summary | Summarize continuous variables as a flextable

## -- D --

delete_columns | Delete flextable columns
delete_part | Delete flextable part
delete_rows | Delete flextable rows
df_printer | data.frame automatic printing as a flextable
dim.flextable | Get column widths and row heights of a flextable
dim.flextableGrob | Get optimal width and height of a flextable grob
dim_pretty | Calculate optimal column widths and row heights

## -- E --

empty_blanks | Make blank columns transparent

## -- F --

fit_columns | Constrain table width by wrapping text
fit_to_width | Constrain table width by shrinking font size
flextable | Create a flextable from a data frame
flextable_dim | Get overall width and height of a flextable
flextable_to_rmd | Print a flextable inside knitr loops and conditionals
fmt_2stats | Format summarizor statistics as text
fmt_avg_dev | Format mean and standard deviation as text
fmt_dbl | Format numbers as doubles
fmt_header_n | Format count as '(N=XX)' for column headers
fmt_int | Format numbers as integers
fmt_n_percent | Format count and percentage as text
fmt_pct | Format numbers as percentages
fmt_signif_after_zeros | Format with significant figures after zeros
fmt_summarizor | Format summarizor statistics as text
font | Set font
fontsize | Set font size
footnote | Add footnotes to flextable
fp_border_default | Create border formatting with flextable defaults
fp_text_default | Create text formatting with flextable defaults

## -- G --

gen_grob | Render a flextable as a graphic object
get_flextable_defaults | Get flextable defaults formatting properties
gg_chunk | ggplot chunk
grid_chunk | Grid Graphics chunk

## -- H --

height | Set flextable rows height
height_all | Set flextable rows height
highlight | Set text highlight color
hline | Set horizontal borders below selected rows
hline_bottom | Set the bottom border of a table part
hline_top | Set the top border of a table part
hrule | Set how row heights are determined
htmltools_value | Convert a flextable to an HTML object
hyperlink_text | Hyperlink chunk

## -- I --

init_flextable_defaults | Modify flextable defaults formatting properties
italic | Set italic font

## -- K --

keep_with_next | Set Word 'Keep with next' instructions
knit_print.flextable | Render flextable in knitr documents

## -- L --

labelizor | Replace displayed text with labels
linerange | Mini linerange chunk
line_spacing | Set line spacing

## -- M --

merge_at | Merge flextable cells into a single one
merge_h | Merge flextable cells horizontally
merge_h_range | Rowwise merge of a range of columns
merge_none | Delete flextable merging information
merge_v | Merge flextable cells vertically
minibar | Mini barplot chunk
mk_par | Set cell content from paragraph chunks

## -- N --

ncol_keys | Number of columns
nrow_part | Number of rows of a part

## -- P --

padding | Set paragraph paddings
paginate | Prevent page breaks inside a flextable
ph_with.flextable | Add a flextable into a PowerPoint slide
plot.flextable | Plot a flextable
plot.flextableGrob | plot a flextable grob
plot_chunk | Mini plot chunk
prepend_chunks | Prepend chunks to flextable content
print.flextable | Print a flextable
proc_freq | Frequency table

## -- Q --

qflextable | Create a flextable from a data frame

## -- R --

rotate | Rotate cell text
rtf_add.flextable | Add a 'flextable' into an RTF document

## -- S --

save_as_docx | Save flextable objects in a 'Word' file
save_as_html | Save flextable objects in an 'HTML' file
save_as_image | Save a flextable in a 'png' or 'svg' file
save_as_pptx | Save flextable objects in a 'PowerPoint' file
save_as_rtf | Save flextable objects in an 'RTF' file
separate_header | Split column names using a separator into multiple rows
set_caption | Set flextable caption
set_flextable_defaults | Modify flextable defaults formatting properties
set_footer_df | Replace the entire header or footer from a data frame
set_formatter | Set column formatter functions
set_header_df | Replace the entire header or footer from a data frame
set_header_footer_df | Replace the entire header or footer from a data frame
set_header_labels | Rename column labels in the header
set_table_properties | Set table layout and width properties
shift_table | Create a shift table
split_columns | Split a flextable into pages by columns
split_rows | Split a flextable into pages by rows
split_to_pages | Split a flextable into pages by rows and columns
style | Set formatting properties on a flextable selection
summarizor | Prepare descriptive statistics for flextable
summary.tabulator | Create pivot-style summary tables
surround | Surround cells with borders

## -- T --

tabulator | Create pivot-style summary tables
tabulator_colnames | Column keys of tabulator objects
tab_settings | Set tabulation marks configuration
theme_alafoli | Apply alafoli theme
theme_apa | Apply APA theme
theme_booktabs | Apply booktabs theme
theme_borderless | Apply borderless theme
theme_box | Apply box theme
theme_tron | Apply tron theme
theme_tron_legacy | Apply tron legacy theme
theme_vader | Apply Sith Lord Darth Vader theme
theme_vanilla | Apply vanilla theme
theme_zebra | Apply zebra theme
to_html.flextable | Get HTML code as a string

## -- U --

use_df_printer | Set data.frame automatic printing as a flextable
use_flextable_qmd | Install the flextable-qmd Quarto extension
use_model_printer | Set automatic flextable printing for models

## -- V --

valign | Set vertical alignment
vline | Set vertical borders to the right of selected columns
vline_left | Set the left border of the table
vline_right | Set the right border of the table
void | Clear the displayed content of selected columns

## -- W --

width | Set columns width
wrap_flextable | Wrap a flextable for use with patchwork