Hao Zhu | bff0191 | 2017-05-23 18:05:00 -0400 | [diff] [blame] | 1 | % Generated by roxygen2: do not edit by hand |
| 2 | % Please edit documentation in R/column_spec.R |
| 3 | \name{column_spec} |
| 4 | \alias{column_spec} |
| 5 | \title{Specify the look of the selected column} |
| 6 | \usage{ |
Hao Zhu | 78e6122 | 2017-05-24 20:53:35 -0400 | [diff] [blame] | 7 | column_spec(kable_input, column, width = NULL, bold = FALSE, |
Hao Zhu | 53454f0 | 2018-01-14 16:29:10 -0500 | [diff] [blame^] | 8 | italic = FALSE, monospace = FALSE, underline = FALSE, |
| 9 | strikeout = FALSE, color = NULL, background = NULL, |
Hao Zhu | b1de967 | 2018-01-08 16:29:24 -0500 | [diff] [blame] | 10 | border_left = FALSE, border_right = FALSE, extra_css = NULL) |
Hao Zhu | bff0191 | 2017-05-23 18:05:00 -0400 | [diff] [blame] | 11 | } |
| 12 | \arguments{ |
Hao Zhu | 76281fe | 2017-07-03 19:33:09 -0400 | [diff] [blame] | 13 | \item{kable_input}{Output of \code{knitr::kable()} with \code{format} specified} |
Hao Zhu | bff0191 | 2017-05-23 18:05:00 -0400 | [diff] [blame] | 14 | |
Hao Zhu | 322de08 | 2017-09-11 19:25:29 -0400 | [diff] [blame] | 15 | \item{column}{A numeric value or vector indicating which column(s) to be selected.} |
Hao Zhu | bff0191 | 2017-05-23 18:05:00 -0400 | [diff] [blame] | 16 | |
| 17 | \item{width}{A character string telling HTML & LaTeX how wide the column |
| 18 | needs to be, e.g. "10cm", "3in" or "30em".} |
| 19 | |
| 20 | \item{bold}{A T/F value to control whether the text of the selected column |
| 21 | need to be bolded.} |
| 22 | |
| 23 | \item{italic}{A T/F value to control whether the text of the selected column |
| 24 | need to be emphasized.} |
Hao Zhu | 8f20299 | 2017-07-15 02:20:18 -0400 | [diff] [blame] | 25 | |
| 26 | \item{monospace}{A T/F value to control whether the text of the selected column |
| 27 | need to be monospaced (verbatim)} |
Hao Zhu | ec7ab92 | 2017-08-19 22:56:44 -0400 | [diff] [blame] | 28 | |
Hao Zhu | 53454f0 | 2018-01-14 16:29:10 -0500 | [diff] [blame^] | 29 | \item{underline}{A T/F value to control whether the text of the selected row |
| 30 | need to be underlined} |
| 31 | |
| 32 | \item{strikeout}{A T/F value to control whether the text of the selected row |
| 33 | need to be stricked out.} |
| 34 | |
Hao Zhu | 53e240f | 2017-09-04 20:04:29 -0400 | [diff] [blame] | 35 | \item{color}{A character string for column text color. Here please pay |
| 36 | attention to the differences in color codes between HTML and LaTeX.} |
Hao Zhu | ec7ab92 | 2017-08-19 22:56:44 -0400 | [diff] [blame] | 37 | |
Hao Zhu | 53e240f | 2017-09-04 20:04:29 -0400 | [diff] [blame] | 38 | \item{background}{A character string for column background color. Here please |
| 39 | pay attention to the differences in color codes between HTML and LaTeX.} |
| 40 | |
| 41 | \item{border_left}{A logical variable indicating whether there should be a |
| 42 | border line on the left of the selected column. In HTML, you can also pass |
| 43 | in a character string for the CSS of the border line} |
| 44 | |
| 45 | \item{border_right}{A logical variable indicating whether there should be a |
| 46 | border line on the right of the selected column. In HTML, you can also pass |
| 47 | in a character string for the CSS of the border line} |
Hao Zhu | b1de967 | 2018-01-08 16:29:24 -0500 | [diff] [blame] | 48 | |
| 49 | \item{extra_css}{Extra css text to be passed into the cells of the row. Note |
| 50 | that it's not for the whole column but to each individual cells} |
Hao Zhu | bff0191 | 2017-05-23 18:05:00 -0400 | [diff] [blame] | 51 | } |
| 52 | \description{ |
| 53 | This function allows users to select a column and then specify |
Hao Zhu | e7c8f70 | 2017-10-10 13:22:59 -0400 | [diff] [blame] | 54 | its look. |
Hao Zhu | bff0191 | 2017-05-23 18:05:00 -0400 | [diff] [blame] | 55 | } |
Hao Zhu | 78e6122 | 2017-05-24 20:53:35 -0400 | [diff] [blame] | 56 | \examples{ |
| 57 | x <- knitr::kable(head(mtcars), "html") |
Hao Zhu | 4840bc9 | 2017-09-15 15:55:05 -0400 | [diff] [blame] | 58 | column_spec(x, 1:2, width = "20em", bold = TRUE, italic = TRUE) |
Hao Zhu | 78e6122 | 2017-05-24 20:53:35 -0400 | [diff] [blame] | 59 | |
| 60 | } |