Hao Zhu | 79f1e2a | 2017-06-11 20:55:30 -0400 | [diff] [blame] | 1 | % 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 Zhu | 3e53e60 | 2017-07-26 12:40:57 -0400 | [diff] [blame] | 7 | row_spec(kable_input, row, bold = FALSE, italic = FALSE, |
Hao Zhu | ec7ab92 | 2017-08-19 22:56:44 -0400 | [diff] [blame] | 8 | monospace = FALSE, color = NULL, background = NULL) |
Hao Zhu | 79f1e2a | 2017-06-11 20:55:30 -0400 | [diff] [blame] | 9 | } |
| 10 | \arguments{ |
Hao Zhu | 76281fe | 2017-07-03 19:33:09 -0400 | [diff] [blame] | 11 | \item{kable_input}{Output of \code{knitr::kable()} with \code{format} specified} |
Hao Zhu | 79f1e2a | 2017-06-11 20:55:30 -0400 | [diff] [blame] | 12 | |
Hao Zhu | 322de08 | 2017-09-11 19:25:29 -0400 | [diff] [blame] | 13 | \item{row}{A numeric value or vector indicating which row(s) to be selected. You don't |
Hao Zhu | 2a87e8e | 2017-06-14 15:49:33 -0400 | [diff] [blame] | 14 | need to count in header rows or group labeling rows.} |
Hao Zhu | 79f1e2a | 2017-06-11 20:55:30 -0400 | [diff] [blame] | 15 | |
| 16 | \item{bold}{A T/F value to control whether the text of the selected row |
| 17 | need to be bolded.} |
| 18 | |
| 19 | \item{italic}{A T/F value to control whether the text of the selected row |
| 20 | need to be emphasized.} |
Hao Zhu | 3e53e60 | 2017-07-26 12:40:57 -0400 | [diff] [blame] | 21 | |
| 22 | \item{monospace}{A T/F value to control whether the text of the selected column |
| 23 | need to be monospaced (verbatim)} |
Hao Zhu | 53e240f | 2017-09-04 20:04:29 -0400 | [diff] [blame] | 24 | |
| 25 | \item{color}{A character string for column text color. Here please pay |
| 26 | attention to the differences in color codes between HTML and LaTeX.} |
| 27 | |
| 28 | \item{background}{A character string for column background color. Here please |
| 29 | pay attention to the differences in color codes between HTML and LaTeX.} |
Hao Zhu | 79f1e2a | 2017-06-11 20:55:30 -0400 | [diff] [blame] | 30 | } |
| 31 | \description{ |
| 32 | This function allows users to select a row and then specify |
| 33 | its look. Right now it supports the following two properties: bold text and |
| 34 | italic text. |
| 35 | } |
| 36 | \examples{ |
| 37 | x <- knitr::kable(head(mtcars), "html") |
Hao Zhu | 4840bc9 | 2017-09-15 15:55:05 -0400 | [diff] [blame^] | 38 | row_spec(x, 1:2, bold = TRUE, italic = TRUE) |
Hao Zhu | 79f1e2a | 2017-06-11 20:55:30 -0400 | [diff] [blame] | 39 | |
| 40 | } |