Hao Zhu | bacd2f3 | 2017-10-11 14:06:36 -0400 | [diff] [blame] | 1 | % Generated by roxygen2: do not edit by hand |
| 2 | % Please edit documentation in R/cell_spec.R |
| 3 | \name{cell_spec} |
| 4 | \alias{cell_spec} |
Hao Zhu | ce5ee41 | 2017-10-23 01:14:38 -0400 | [diff] [blame] | 5 | \alias{text_spec} |
| 6 | \title{Specify Cell/Text format} |
Hao Zhu | bacd2f3 | 2017-10-11 14:06:36 -0400 | [diff] [blame] | 7 | \usage{ |
Hao Zhu | 6f362bb | 2017-10-23 23:21:38 -0400 | [diff] [blame] | 8 | cell_spec(x, format, bold = FALSE, italic = FALSE, monospace = FALSE, |
| 9 | color = NULL, background = NULL, align = NULL, font_size = NULL, |
| 10 | angle = NULL, tooltip = NULL, popover = NULL, link = NULL, |
Hao Zhu | b1de967 | 2018-01-08 16:29:24 -0500 | [diff] [blame] | 11 | extra_css = NULL, escape = TRUE, background_as_tile = TRUE, |
Hao Zhu | ce5ee41 | 2017-10-23 01:14:38 -0400 | [diff] [blame] | 12 | latex_background_in_cell = TRUE) |
| 13 | |
Hao Zhu | 6f362bb | 2017-10-23 23:21:38 -0400 | [diff] [blame] | 14 | text_spec(x, format, bold = FALSE, italic = FALSE, monospace = FALSE, |
| 15 | color = NULL, background = NULL, align = NULL, font_size = NULL, |
| 16 | angle = NULL, tooltip = NULL, popover = NULL, link = NULL, |
| 17 | escape = TRUE, background_as_tile = TRUE, |
Hao Zhu | ce5ee41 | 2017-10-23 01:14:38 -0400 | [diff] [blame] | 18 | latex_background_in_cell = FALSE) |
Hao Zhu | bacd2f3 | 2017-10-11 14:06:36 -0400 | [diff] [blame] | 19 | } |
| 20 | \arguments{ |
| 21 | \item{x}{Things to be formated. It could be a vector of numbers or strings.} |
| 22 | |
| 23 | \item{format}{Either "html" or "latex". It can also be set through |
| 24 | \code{option(knitr.table.format)}, same as \code{knitr::kable()}.} |
| 25 | |
Hao Zhu | ce5ee41 | 2017-10-23 01:14:38 -0400 | [diff] [blame] | 26 | \item{bold}{T/F for font bold.} |
Hao Zhu | bacd2f3 | 2017-10-11 14:06:36 -0400 | [diff] [blame] | 27 | |
Hao Zhu | ce5ee41 | 2017-10-23 01:14:38 -0400 | [diff] [blame] | 28 | \item{italic}{T/F for font italic.} |
Hao Zhu | bacd2f3 | 2017-10-11 14:06:36 -0400 | [diff] [blame] | 29 | |
Hao Zhu | ce5ee41 | 2017-10-23 01:14:38 -0400 | [diff] [blame] | 30 | \item{monospace}{T/F for font monospaced (verbatim)} |
Hao Zhu | bacd2f3 | 2017-10-11 14:06:36 -0400 | [diff] [blame] | 31 | |
Hao Zhu | ce5ee41 | 2017-10-23 01:14:38 -0400 | [diff] [blame] | 32 | \item{color}{A character string for text color. Here please pay |
Hao Zhu | bacd2f3 | 2017-10-11 14:06:36 -0400 | [diff] [blame] | 33 | attention to the differences in color codes between HTML and LaTeX.} |
| 34 | |
Hao Zhu | ce5ee41 | 2017-10-23 01:14:38 -0400 | [diff] [blame] | 35 | \item{background}{A character string for background color. Here please |
| 36 | pay attention to the differences in color codes between HTML and LaTeX. Also |
| 37 | note that in HTML, background defined in cell_spec won't cover the whole |
| 38 | cell.} |
Hao Zhu | bacd2f3 | 2017-10-11 14:06:36 -0400 | [diff] [blame] | 39 | |
Hao Zhu | ce5ee41 | 2017-10-23 01:14:38 -0400 | [diff] [blame] | 40 | \item{align}{A character string for cell alignment. For HTML, possible |
| 41 | values could be \code{l}, \code{c}, \code{r} plus \code{left}, \code{center}, \code{right}, \code{justify}, |
| 42 | \code{initial} and \code{inherit} while for LaTeX, you can only choose |
| 43 | from \code{l}, \code{c} & \code{r}.} |
Hao Zhu | bacd2f3 | 2017-10-11 14:06:36 -0400 | [diff] [blame] | 44 | |
Hao Zhu | 6f362bb | 2017-10-23 23:21:38 -0400 | [diff] [blame] | 45 | \item{font_size}{A numeric input for font size. For HTML, you can also use |
Hao Zhu | 8b32b19 | 2017-10-24 14:51:48 -0400 | [diff] [blame] | 46 | options including \code{xx-small}, \code{x-small}, \code{small}, \code{medium}, \code{large}, |
| 47 | \code{x-large}, \code{xx-large}, \code{smaller}, \code{larger}, \code{initial} and \code{inherit}.} |
Hao Zhu | bacd2f3 | 2017-10-11 14:06:36 -0400 | [diff] [blame] | 48 | |
Hao Zhu | 9ce317e | 2017-10-12 18:19:55 -0400 | [diff] [blame] | 49 | \item{angle}{0-360, degree that the text will rotate. Can be a vector.} |
| 50 | |
Hao Zhu | 064990d | 2017-10-17 18:08:42 -0400 | [diff] [blame] | 51 | \item{tooltip}{A vector of strings to be displayed as tooltip. |
Hao Zhu | 6f362bb | 2017-10-23 23:21:38 -0400 | [diff] [blame] | 52 | Obviously, this feature is only available in HTML. Read the package |
| 53 | vignette to see how to use bootstrap tooltip css to improve the loading |
| 54 | speed and look.} |
| 55 | |
| 56 | \item{popover}{Similar with tooltip but can hold more contents. The best way |
| 57 | to build a popover is through \code{spec_popover()}. If you only provide a text |
| 58 | string, it will be used as content. Note that You have to enable this |
| 59 | bootstrap module manually. Read the package vignette to see how.} |
| 60 | |
| 61 | \item{link}{A vector of strings for url links. Can be used together with |
| 62 | tooltip and popover.} |
| 63 | |
Hao Zhu | b1de967 | 2018-01-08 16:29:24 -0500 | [diff] [blame] | 64 | \item{extra_css}{Extra css text to be passed into the cell} |
| 65 | |
Hao Zhu | 6f362bb | 2017-10-23 23:21:38 -0400 | [diff] [blame] | 66 | \item{escape}{T/F value showing whether special characters should be escaped.} |
Hao Zhu | 457acb4 | 2017-10-14 17:37:02 -0400 | [diff] [blame] | 67 | |
| 68 | \item{background_as_tile}{T/F value indicating if you want to have round |
Hao Zhu | ce5ee41 | 2017-10-23 01:14:38 -0400 | [diff] [blame] | 69 | cornered tile as background in HTML.} |
| 70 | |
| 71 | \item{latex_background_in_cell}{T/F value. It only takes effect in LaTeX |
| 72 | when \code{background} provided, Default value is \code{TRUE}. If it's \code{TRUE}, the |
| 73 | background only works in a table cell. If it's \code{FALSE}, it works outside of a |
| 74 | table environment.} |
Hao Zhu | bacd2f3 | 2017-10-11 14:06:36 -0400 | [diff] [blame] | 75 | } |
| 76 | \description{ |
| 77 | Specify Cell format before it gets into kable |
| 78 | } |