blob: cf4b5cf9bdd7b6ad1d468ece4037706d793776e7 [file] [log] [blame]
Hao Zhubff01912017-05-23 18:05:00 -04001% 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 Zhu78e61222017-05-24 20:53:35 -04007column_spec(kable_input, column, width = NULL, bold = FALSE,
8 italic = FALSE)
Hao Zhubff01912017-05-23 18:05:00 -04009}
10\arguments{
11\item{kable_input}{Output of `knitr::kable()` with `format` specified}
12
Hao Zhubf5bfe22017-06-21 14:37:41 -040013\item{column}{A numeric value indicating which column to be selected. When
14you do the counting, ignore the extra header columns you added through
15add_header_left.}
Hao Zhubff01912017-05-23 18:05:00 -040016
17\item{width}{A character string telling HTML & LaTeX how wide the column
18needs 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
21need to be bolded.}
22
23\item{italic}{A T/F value to control whether the text of the selected column
24need to be emphasized.}
25}
26\description{
27This function allows users to select a column and then specify
28its look. Right now it supports the following three properties: column width,
29bold text and italic text.
30}
Hao Zhu78e61222017-05-24 20:53:35 -040031\examples{
32x <- knitr::kable(head(mtcars), "html")
33column_spec(x, 1, width = "20em", bold = TRUE, italic = TRUE)
34
35}