Chunk of text wrapper

The function lets add formated text in flextable cells.

It is used to add it to the content of a cell of the flextable with the functions compose(), append_chunks() or prepend_chunks().

It should be used inside a call to as_paragraph().

Usage

as_chunk(x, props = NULL, formatter = format_fun, ...)

Arguments

x

text or any element that can be formatted as text with function provided in argument formatter.

props

an fp_text_default() or officer::fp_text() object to be used to format the text. If not specified, it will be the default value corresponding to the cell.

formatter

a function that will format x as a character vector.

...

additional arguments for formatter function.

See also

Other chunk elements for paragraph: as_b(), as_bracket(), as_equation(), as_highlight(), as_i(), as_image(), as_sub(), as_sup(), as_word_field(), colorize(), gg_chunk(), grid_chunk(), hyperlink_text(), linerange(), lollipop(), minibar(), plot_chunk()

Examples

library(officer)

ft <- flextable(head(iris))

ft <- compose(ft,
  j = "Sepal.Length",
  value = as_paragraph(
    "Sepal.Length value is ",
    as_chunk(Sepal.Length, props = fp_text(color = "red"))
  ),
  part = "body"
)
ft <- color(ft, color = "gray40", part = "all")
ft <- autofit(ft)
ft
Sepal.Length
Sepal.Width
Petal.Length
Petal.Width
Species
Sepal.Length value is 5.1
3.5
1.4
0.2
setosa
Sepal.Length value is 4.9
3.0
1.4
0.2
setosa
Sepal.Length value is 4.7
3.2
1.3
0.2
setosa
Sepal.Length value is 4.6
3.1
1.5
0.2
setosa
Sepal.Length value is 5.0
3.6
1.4
0.2
setosa
Sepal.Length value is 5.4
3.9
1.7
0.4
setosa