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 | b1caa27 | 2018-04-14 14:19:46 -0400 | [diff] [blame] | 10 | border_left = FALSE, border_right = FALSE, width_min = NULL, |
Hao Zhu | 907ddfe | 2018-04-23 15:19:09 -0400 | [diff] [blame^] | 11 | width_max = NULL, extra_css = NULL, include_thead = FALSE) |
Hao Zhu | bff0191 | 2017-05-23 18:05:00 -0400 | [diff] [blame] | 12 | } |
| 13 | \arguments{ |
Hao Zhu | 76281fe | 2017-07-03 19:33:09 -0400 | [diff] [blame] | 14 | \item{kable_input}{Output of \code{knitr::kable()} with \code{format} specified} |
Hao Zhu | bff0191 | 2017-05-23 18:05:00 -0400 | [diff] [blame] | 15 | |
Hao Zhu | 322de08 | 2017-09-11 19:25:29 -0400 | [diff] [blame] | 16 | \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] | 17 | |
| 18 | \item{width}{A character string telling HTML & LaTeX how wide the column |
| 19 | needs to be, e.g. "10cm", "3in" or "30em".} |
| 20 | |
| 21 | \item{bold}{A T/F value to control whether the text of the selected column |
| 22 | need to be bolded.} |
| 23 | |
| 24 | \item{italic}{A T/F value to control whether the text of the selected column |
| 25 | need to be emphasized.} |
Hao Zhu | 8f20299 | 2017-07-15 02:20:18 -0400 | [diff] [blame] | 26 | |
| 27 | \item{monospace}{A T/F value to control whether the text of the selected column |
| 28 | need to be monospaced (verbatim)} |
Hao Zhu | ec7ab92 | 2017-08-19 22:56:44 -0400 | [diff] [blame] | 29 | |
Hao Zhu | 53454f0 | 2018-01-14 16:29:10 -0500 | [diff] [blame] | 30 | \item{underline}{A T/F value to control whether the text of the selected row |
| 31 | need to be underlined} |
| 32 | |
| 33 | \item{strikeout}{A T/F value to control whether the text of the selected row |
| 34 | need to be stricked out.} |
| 35 | |
Hao Zhu | 53e240f | 2017-09-04 20:04:29 -0400 | [diff] [blame] | 36 | \item{color}{A character string for column text color. Here please pay |
| 37 | attention to the differences in color codes between HTML and LaTeX.} |
Hao Zhu | ec7ab92 | 2017-08-19 22:56:44 -0400 | [diff] [blame] | 38 | |
Hao Zhu | 53e240f | 2017-09-04 20:04:29 -0400 | [diff] [blame] | 39 | \item{background}{A character string for column background color. Here please |
| 40 | pay attention to the differences in color codes between HTML and LaTeX.} |
| 41 | |
| 42 | \item{border_left}{A logical variable indicating whether there should be a |
| 43 | border line on the left of the selected column. In HTML, you can also pass |
| 44 | in a character string for the CSS of the border line} |
| 45 | |
| 46 | \item{border_right}{A logical variable indicating whether there should be a |
| 47 | border line on the right of the selected column. In HTML, you can also pass |
| 48 | in a character string for the CSS of the border line} |
Hao Zhu | b1de967 | 2018-01-08 16:29:24 -0500 | [diff] [blame] | 49 | |
| 50 | \item{extra_css}{Extra css text to be passed into the cells of the row. Note |
| 51 | that it's not for the whole column but to each individual cells} |
Hao Zhu | b1caa27 | 2018-04-14 14:19:46 -0400 | [diff] [blame] | 52 | |
Hao Zhu | 907ddfe | 2018-04-23 15:19:09 -0400 | [diff] [blame^] | 53 | \item{include_thead}{T/F. A HTML only feature to contoll whether the |
| 54 | header row will be manipulated. Default is \code{FALSE}.} |
| 55 | |
Hao Zhu | b1caa27 | 2018-04-14 14:19:46 -0400 | [diff] [blame] | 56 | \item{min_width}{Only for HTML table. Normal column width will automatically |
| 57 | collapse when the window cannot hold enough contents. With this \code{min_width}, |
| 58 | you can set up a column with a width that won't collapse even when the |
| 59 | window is not wide enough.} |
| 60 | |
| 61 | \item{max_width}{Only for HTML table. \code{max_width} defines the maximum width |
| 62 | of table columns.} |
Hao Zhu | bff0191 | 2017-05-23 18:05:00 -0400 | [diff] [blame] | 63 | } |
| 64 | \description{ |
| 65 | This function allows users to select a column and then specify |
Hao Zhu | e7c8f70 | 2017-10-10 13:22:59 -0400 | [diff] [blame] | 66 | its look. |
Hao Zhu | bff0191 | 2017-05-23 18:05:00 -0400 | [diff] [blame] | 67 | } |
Hao Zhu | 78e6122 | 2017-05-24 20:53:35 -0400 | [diff] [blame] | 68 | \examples{ |
| 69 | x <- knitr::kable(head(mtcars), "html") |
Hao Zhu | 4840bc9 | 2017-09-15 15:55:05 -0400 | [diff] [blame] | 70 | column_spec(x, 1:2, width = "20em", bold = TRUE, italic = TRUE) |
Hao Zhu | 78e6122 | 2017-05-24 20:53:35 -0400 | [diff] [blame] | 71 | |
| 72 | } |