-
Notifications
You must be signed in to change notification settings - Fork 79
/
as_highlight.Rd
54 lines (50 loc) · 1.32 KB
/
as_highlight.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/05_content.R
\name{as_highlight}
\alias{as_highlight}
\title{Highlight chunk}
\usage{
as_highlight(x, color)
}
\arguments{
\item{x}{value, if a chunk, the chunk will be updated}
\item{color}{color to use as text highlighting color as character vector.}
}
\description{
The function is producing a chunk with
an highlight chunk.
It is used to add it to the content of a cell of the
flextable with the functions \code{\link[=compose]{compose()}}, \code{\link[=append_chunks]{append_chunks()}}
or \code{\link[=prepend_chunks]{prepend_chunks()}}.
}
\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
}
\seealso{
Other chunk elements for paragraph:
\code{\link{as_b}()},
\code{\link{as_bracket}()},
\code{\link{as_chunk}()},
\code{\link{as_equation}()},
\code{\link{as_i}()},
\code{\link{as_image}()},
\code{\link{as_sub}()},
\code{\link{as_sup}()},
\code{\link{as_word_field}()},
\code{\link{colorize}()},
\code{\link{gg_chunk}()},
\code{\link{grid_chunk}()},
\code{\link{hyperlink_text}()},
\code{\link{linerange}()},
\code{\link{lollipop}()},
\code{\link{minibar}()},
\code{\link{plot_chunk}()}
}
\concept{chunk elements for paragraph}