The function is producing a chunk with an highlight chunk.

as_highlight(x, color)

Arguments

x

value, if a chunk, the chunk will be updated

color

color to use as text highlighting color as character vector.

Note

This is a sugar function that ease the composition of complex labels made of different formattings. It should be used inside a call to as_paragraph().

See also

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

Examples

ft <- flextable( head(iris),
  col_keys = c("Sepal.Length", "dummy") )

ft <- compose(ft, j = "dummy",
  value = as_paragraph(as_highlight(Sepal.Length, color = "yellow")) )

ft
#> a flextable object.
#> col_keys: `Sepal.Length`, `dummy` 
#> header has 1 row(s) 
#> body has 6 row(s) 
#> original dataset sample: 
#>   Sepal.Length Sepal.Width Petal.Length Petal.Width Species dummy
#> 1          5.1         3.5          1.4         0.2  setosa      
#> 2          4.9         3.0          1.4         0.2  setosa      
#> 3          4.7         3.2          1.3         0.2  setosa      
#> 4          4.6         3.1          1.5         0.2  setosa      
#> 5          5.0         3.6          1.4         0.2  setosa