blob: ea61e4ac68f8e1c44dd6e156d6661ef94924621d [file] [log] [blame]
Hao Zhu8f417202017-05-20 16:37:14 -04001% Generated by roxygen2: do not edit by hand
2% Please edit documentation in R/add_indent.R
3\name{add_indent}
4\alias{add_indent}
5\title{Add indentations to row headers}
6\usage{
Hao Zhufdff6f42020-08-09 14:38:10 -04007add_indent(kable_input, positions, level_of_indent = 1, all_cols = FALSE)
Hao Zhu8f417202017-05-20 16:37:14 -04008}
Hao Zhubd95bb22017-05-22 16:08:49 -04009\arguments{
Hao Zhu76281fe2017-07-03 19:33:09 -040010\item{kable_input}{Output of \code{knitr::kable()} with \code{format} specified}
Hao Zhubd95bb22017-05-22 16:08:49 -040011
12\item{positions}{A vector of numeric row numbers for the rows that need to
13be indented.}
Hao Zhu9410a272020-08-03 01:11:47 -040014
15\item{level_of_indent}{a numeric value for the indent level. Default is 1.}
Hao Zhuf2f42022020-08-18 22:48:52 -040016
17\item{all_cols}{T/F whether to apply indentation to all columns}
Hao Zhubd95bb22017-05-22 16:08:49 -040018}
Hao Zhu8f417202017-05-20 16:37:14 -040019\description{
20Add indentations to row headers
21}
Hao Zhu78e61222017-05-24 20:53:35 -040022\examples{
Hao Zhu9399dcc2020-08-26 17:27:38 -040023\dontrun{
Hao Zhu78e61222017-05-24 20:53:35 -040024x <- knitr::kable(head(mtcars), "html")
25# Add indentations to the 2nd & 4th row
Hao Zhu9410a272020-08-03 01:11:47 -040026add_indent(x, c(2, 4), level_of_indent = 1)
Hao Zhu9399dcc2020-08-26 17:27:38 -040027}
Hao Zhu78e61222017-05-24 20:53:35 -040028
29}