blob: 49f9833804645e8793d1a60e94ffa51b61ed5c05 [file] [log] [blame]
Hao Zhu2a87e8e2017-06-14 15:49:33 -04001% Generated by roxygen2: do not edit by hand
2% Please edit documentation in R/collapse_rows.R
3\name{collapse_rows}
4\alias{collapse_rows}
Hao Zhu8a160b12017-06-26 13:41:35 -10005\title{Collapse repeated rows to multirow cell}
Hao Zhu2a87e8e2017-06-14 15:49:33 -04006\usage{
Hao Zhu53454f02018-01-14 16:29:10 -05007collapse_rows(kable_input, columns = NULL, latex_hline = c("full", "major",
Hao Zhu248bbef2018-04-02 18:25:14 -04008 "none", "custom"), row_group_label_position = c("identity", "stack"),
9 custom_latex_hline = NULL, row_group_label_fonts = NULL,
10 headers_to_remove = NULL)
Hao Zhu8a160b12017-06-26 13:41:35 -100011}
12\arguments{
Hao Zhu76281fe2017-07-03 19:33:09 -040013\item{kable_input}{Output of \code{knitr::kable()} with \code{format} specified}
Hao Zhu8a160b12017-06-26 13:41:35 -100014
15\item{columns}{Numeric column positions where rows need to be collapsed.}
Hao Zhu53454f02018-01-14 16:29:10 -050016
17\item{latex_hline}{Option controlling the behavior of adding hlines to table.
Hao Zhu248bbef2018-04-02 18:25:14 -040018Choose from \code{full}, \code{major}, \code{none}, \code{custom}.}
19
20\item{row_group_label_position}{Option controlling positions of row group
21labels. Choose from \code{identity}, \code{stack}.}
22
23\item{custom_latex_hline}{Numeric column positions whose collapsed rows will
24be separated by hlines.}
25
26\item{row_group_label_fonts}{A list of arguments that can be supplied to
27group_rows function to format the row group label when
28\code{row_group_label_position} is \code{stack}}
29
30\item{headers_to_remove}{Numeric column positions where headers should be
31removed when they are stacked.}
Hao Zhu2a87e8e2017-06-14 15:49:33 -040032}
33\description{
Hao Zhu8a160b12017-06-26 13:41:35 -100034Collapse same values in columns into multirow cells. This
Hao Zhu76281fe2017-07-03 19:33:09 -040035feature does similar things with \code{group_rows}. However, unlike \code{group_rows},
Hao Zhu8a160b12017-06-26 13:41:35 -100036it analyzes existing columns, finds out rows that can be grouped together,
Hao Zhu76281fe2017-07-03 19:33:09 -040037and make them multirow cells. Note that if you want to use \code{column_spec} to
38specify column styles, you should use \code{column_spec} before \code{collapse_rows}.
Hao Zhu2a87e8e2017-06-14 15:49:33 -040039}
Hao Zhu5a7689e2017-06-26 15:37:24 -100040\examples{
41dt <- data.frame(a = c(1, 1, 2, 2), b = c("a", "a", "a", "b"))
42x <- knitr::kable(dt, "html")
43collapse_rows(x)
44
45}