blob: 4a94983146dc837bb79e0a2347c0496d47d9dff2 [file] [log] [blame]
Hao Zhu79f1e2a2017-06-11 20:55:30 -04001% 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 Zhu3e53e602017-07-26 12:40:57 -04007row_spec(kable_input, row, bold = FALSE, italic = FALSE,
Hao Zhuec7ab922017-08-19 22:56:44 -04008 monospace = FALSE, color = NULL, background = NULL)
Hao Zhu79f1e2a2017-06-11 20:55:30 -04009}
10\arguments{
Hao Zhu76281fe2017-07-03 19:33:09 -040011\item{kable_input}{Output of \code{knitr::kable()} with \code{format} specified}
Hao Zhu79f1e2a2017-06-11 20:55:30 -040012
Hao Zhu322de082017-09-11 19:25:29 -040013\item{row}{A numeric value or vector indicating which row(s) to be selected. You don't
Hao Zhu2a87e8e2017-06-14 15:49:33 -040014need to count in header rows or group labeling rows.}
Hao Zhu79f1e2a2017-06-11 20:55:30 -040015
16\item{bold}{A T/F value to control whether the text of the selected row
17need to be bolded.}
18
19\item{italic}{A T/F value to control whether the text of the selected row
20need to be emphasized.}
Hao Zhu3e53e602017-07-26 12:40:57 -040021
22\item{monospace}{A T/F value to control whether the text of the selected column
23need to be monospaced (verbatim)}
Hao Zhu53e240f2017-09-04 20:04:29 -040024
25\item{color}{A character string for column text color. Here please pay
26attention to the differences in color codes between HTML and LaTeX.}
27
28\item{background}{A character string for column background color. Here please
29pay attention to the differences in color codes between HTML and LaTeX.}
Hao Zhu79f1e2a2017-06-11 20:55:30 -040030}
31\description{
32This function allows users to select a row and then specify
33its look. Right now it supports the following two properties: bold text and
34italic text.
35}
36\examples{
37x <- knitr::kable(head(mtcars), "html")
Hao Zhu4840bc92017-09-15 15:55:05 -040038row_spec(x, 1:2, bold = TRUE, italic = TRUE)
Hao Zhu79f1e2a2017-06-11 20:55:30 -040039
40}