blob: 9d5e0504288b08fa63f16c8d2c95f058c4243f23 [file] [log] [blame]
Hao Zhubacd2f32017-10-11 14:06:36 -04001% 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 Zhuce5ee412017-10-23 01:14:38 -04005\alias{text_spec}
6\title{Specify Cell/Text format}
Hao Zhubacd2f32017-10-11 14:06:36 -04007\usage{
8cell_spec(x, format, bold = F, italic = F, monospace = F, color = NULL,
Hao Zhu9ce317e2017-10-12 18:19:55 -04009 background = NULL, align = NULL, font_size = NULL, angle = NULL,
Hao Zhuce5ee412017-10-23 01:14:38 -040010 tooltip = NULL, background_as_tile = TRUE,
11 latex_background_in_cell = TRUE)
12
13text_spec(x, format, bold = F, italic = F, monospace = F, color = NULL,
14 background = NULL, align = NULL, font_size = NULL, angle = NULL,
15 tooltip = NULL, background_as_tile = TRUE,
16 latex_background_in_cell = FALSE)
Hao Zhubacd2f32017-10-11 14:06:36 -040017}
18\arguments{
19\item{x}{Things to be formated. It could be a vector of numbers or strings.}
20
21\item{format}{Either "html" or "latex". It can also be set through
22\code{option(knitr.table.format)}, same as \code{knitr::kable()}.}
23
Hao Zhuce5ee412017-10-23 01:14:38 -040024\item{bold}{T/F for font bold.}
Hao Zhubacd2f32017-10-11 14:06:36 -040025
Hao Zhuce5ee412017-10-23 01:14:38 -040026\item{italic}{T/F for font italic.}
Hao Zhubacd2f32017-10-11 14:06:36 -040027
Hao Zhuce5ee412017-10-23 01:14:38 -040028\item{monospace}{T/F for font monospaced (verbatim)}
Hao Zhubacd2f32017-10-11 14:06:36 -040029
Hao Zhuce5ee412017-10-23 01:14:38 -040030\item{color}{A character string for text color. Here please pay
Hao Zhubacd2f32017-10-11 14:06:36 -040031attention to the differences in color codes between HTML and LaTeX.}
32
Hao Zhuce5ee412017-10-23 01:14:38 -040033\item{background}{A character string for background color. Here please
34pay attention to the differences in color codes between HTML and LaTeX. Also
35note that in HTML, background defined in cell_spec won't cover the whole
36cell.}
Hao Zhubacd2f32017-10-11 14:06:36 -040037
Hao Zhuce5ee412017-10-23 01:14:38 -040038\item{align}{A character string for cell alignment. For HTML, possible
39values could be \code{l}, \code{c}, \code{r} plus \code{left}, \code{center}, \code{right}, \code{justify},
40\code{initial} and \code{inherit} while for LaTeX, you can only choose
41from \code{l}, \code{c} & \code{r}.}
Hao Zhubacd2f32017-10-11 14:06:36 -040042
Hao Zhuce5ee412017-10-23 01:14:38 -040043\item{font_size}{j}
Hao Zhubacd2f32017-10-11 14:06:36 -040044
Hao Zhu9ce317e2017-10-12 18:19:55 -040045\item{angle}{0-360, degree that the text will rotate. Can be a vector.}
46
Hao Zhu064990d2017-10-17 18:08:42 -040047\item{tooltip}{A vector of strings to be displayed as tooltip.
Hao Zhuce5ee412017-10-23 01:14:38 -040048Obviously, this feature is only available in HTML.}
Hao Zhu457acb42017-10-14 17:37:02 -040049
50\item{background_as_tile}{T/F value indicating if you want to have round
Hao Zhuce5ee412017-10-23 01:14:38 -040051cornered tile as background in HTML.}
52
53\item{latex_background_in_cell}{T/F value. It only takes effect in LaTeX
54when \code{background} provided, Default value is \code{TRUE}. If it's \code{TRUE}, the
55background only works in a table cell. If it's \code{FALSE}, it works outside of a
56table environment.}
Hao Zhubacd2f32017-10-11 14:06:36 -040057}
58\description{
59Specify Cell format before it gets into kable
60}