flextable (version 0.6.0)

set_flextable_defaults: Modify flextable defaults formatting properties

Description

The current formatting properties (see get_flextable_defaults()) are automatically applied to every flextable you produce. Use set_flextable_defaults() to override them.

Usage

set_flextable_defaults(
  font.family = NULL,
  font.size = NULL,
  font.color = NULL,
  text.align = NULL,
  padding.bottom = NULL,
  padding.top = NULL,
  padding.left = NULL,
  padding.right = NULL,
  border.color = NULL,
  background.color = NULL,
  table.layout = NULL,
  decimal.mark = NULL,
  big.mark = NULL,
  digits = NULL,
  na_str = NULL,
  fmt_date = NULL,
  fmt_datetime = NULL,
  fonts_ignore = NULL,
  theme_fun = NULL
)

Arguments

font.family

single character value specifying font name.

font.size

font size (in point) - 0 or positive integer value.

font.color

font color - a single character value specifying a valid color (e.g. "#000000" or "black").

text.align

text alignment - a single character value, expected value is one of 'left', 'right', 'center', 'justify'.

padding.bottom, padding.top, padding.left, padding.right

paragraph paddings - 0 or positive integer value.

border.color

border color - single character value (e.g. "#000000" or "black").

background.color

cell background color - a single character value specifying a valid color (e.g. "#000000" or "black").

table.layout

'autofit' or 'fixed' algorithm. Default to 'autofit'.

decimal.mark, big.mark, digits, na_str

formatC arguments used by colformat_num() and colformat_int().

fmt_date, fmt_datetime

formats for date and datetime columns as documented in strptime(). Default to '%Y-%m-%d' and '%Y-%m-%d %H:%M:%S'.

fonts_ignore

if TRUE, pdf-engine pdflatex can be used instead of xelatex or lualatex. If pdflatex is used, fonts will be ignored because they are not supported by pdflatex, whereas with the xelatex and lualatex engines they are.

theme_fun

a single character value (the name of the theme function to be applied) or a theme function (input is a flextable, output is a flextable).

Value

a list containing previous default values.

Illustrations

See Also

Other functions related to themes: get_flextable_defaults(), theme_alafoli(), theme_booktabs(), theme_box(), theme_tron_legacy(), theme_tron(), theme_vader(), theme_vanilla(), theme_zebra()

Examples

# NOT RUN {
ft_1 <- qflextable(head(airquality))
ft_1

old <- set_flextable_defaults(
  font.color = "#AA8855",
  border.color = "#8855AA")
ft_2 <- qflextable(head(airquality))
ft_2

do.call(set_flextable_defaults, old)
# }