blob: 70d070b1d96a19aff22b05b80411ed93ea1380f8 [file] [log] [blame]
Hao Zhu79f1e2a2017-06-11 20:55:30 -04001% Generated by roxygen2: do not edit by hand
2% Please edit documentation in R/row_spec.R
3\name{row_spec}
4\alias{row_spec}
5\title{Specify the look of the selected row}
6\usage{
Hao Zhu9410a272020-08-03 01:11:47 -04007row_spec(
8 kable_input,
9 row,
10 bold = FALSE,
11 italic = FALSE,
12 monospace = FALSE,
13 underline = FALSE,
14 strikeout = FALSE,
15 color = NULL,
16 background = NULL,
17 align = NULL,
18 font_size = NULL,
19 angle = NULL,
20 extra_css = NULL,
21 hline_after = FALSE,
22 extra_latex_after = NULL
23)
Hao Zhu79f1e2a2017-06-11 20:55:30 -040024}
25\arguments{
Hao Zhu76281fe2017-07-03 19:33:09 -040026\item{kable_input}{Output of \code{knitr::kable()} with \code{format} specified}
Hao Zhu79f1e2a2017-06-11 20:55:30 -040027
Hao Zhu322de082017-09-11 19:25:29 -040028\item{row}{A numeric value or vector indicating which row(s) to be selected. You don't
Hao Zhu2a87e8e2017-06-14 15:49:33 -040029need to count in header rows or group labeling rows.}
Hao Zhu79f1e2a2017-06-11 20:55:30 -040030
31\item{bold}{A T/F value to control whether the text of the selected row
32need to be bolded.}
33
34\item{italic}{A T/F value to control whether the text of the selected row
35need to be emphasized.}
Hao Zhu3e53e602017-07-26 12:40:57 -040036
Hao Zhu53454f02018-01-14 16:29:10 -050037\item{monospace}{A T/F value to control whether the text of the selected row
Hao Zhu3e53e602017-07-26 12:40:57 -040038need to be monospaced (verbatim)}
Hao Zhu53e240f2017-09-04 20:04:29 -040039
Hao Zhu53454f02018-01-14 16:29:10 -050040\item{underline}{A T/F value to control whether the text of the selected row
41need to be underlined}
42
43\item{strikeout}{A T/F value to control whether the text of the selected row
44need to be stricked out.}
45
Hao Zhu457acb42017-10-14 17:37:02 -040046\item{color}{A character string for row text color. For example, "red" or
47"#BBBBBB".}
Hao Zhu53e240f2017-09-04 20:04:29 -040048
Hao Zhue7c8f702017-10-10 13:22:59 -040049\item{background}{A character string for row background color. Here please
Hao Zhu53e240f2017-09-04 20:04:29 -040050pay attention to the differences in color codes between HTML and LaTeX.}
Hao Zhue7c8f702017-10-10 13:22:59 -040051
52\item{align}{A character string for cell alignment. For HTML, possible values could
53be \code{l}, \code{c}, \code{r} plus \code{left}, \code{center}, \code{right}, \code{justify}, \code{initial} and \code{inherit}
54while for LaTeX, you can only choose from \code{l}, \code{c} & \code{r}.}
55
Hao Zhu8b32b192017-10-24 14:51:48 -040056\item{font_size}{A numeric input for font size. For HTML, you can also use
57options including \code{xx-small}, \code{x-small}, \code{small}, \code{medium}, \code{large},
58\code{x-large}, \code{xx-large}, \code{smaller}, \code{larger}, \code{initial} and \code{inherit}.}
Hao Zhubacd2f32017-10-11 14:06:36 -040059
60\item{angle}{0-360, degree that the text will rotate.}
Hao Zhub1de9672018-01-08 16:29:24 -050061
62\item{extra_css}{Extra css text to be passed into the cells of the row. Note
63that it's not for the whole row.}
Hao Zhu53454f02018-01-14 16:29:10 -050064
65\item{hline_after}{T/F. A replicate of \code{hline.after} in xtable. It
66addes a hline after ther row}
67
68\item{extra_latex_after}{Extra LaTeX text to be added after the row. Similar
69with \code{add.to.row} in xtable}
Hao Zhu79f1e2a2017-06-11 20:55:30 -040070}
71\description{
72This function allows users to select a row and then specify
Hao Zhue7c8f702017-10-10 13:22:59 -040073its look. It can also specify the format of the header row when \code{row} = 0.
Hao Zhu79f1e2a2017-06-11 20:55:30 -040074}
75\examples{
Hao Zhu9399dcc2020-08-26 17:27:38 -040076\dontrun{
Hao Zhu79f1e2a2017-06-11 20:55:30 -040077x <- knitr::kable(head(mtcars), "html")
Hao Zhu4840bc92017-09-15 15:55:05 -040078row_spec(x, 1:2, bold = TRUE, italic = TRUE)
Hao Zhu9399dcc2020-08-26 17:27:38 -040079}
Hao Zhu79f1e2a2017-06-11 20:55:30 -040080
81}