Merge, rebuild man pages
Merge branch 'master' of https://github.com/haozhu233/kableExtra
# Conflicts:
# man/kable_styling.Rd
diff --git a/man/add_header_above.Rd b/man/add_header_above.Rd
index ee4ad8c..5174db8 100644
--- a/man/add_header_above.Rd
+++ b/man/add_header_above.Rd
@@ -16,7 +16,7 @@
\item{header}{A (named) character vector with \code{colspan} as values. For
example, \code{c(" " = 1, "title" = 2)} can be used to create a new header row
for a 3-column table with "title" spanning across column 2 and 3. For
-convenience, when \code{colspan} equals to 1, users can drop the \code{= 1} part.
+convenience, when \code{colspan} equals to 1, users can drop the \code{ = 1} part.
As a result, \code{c(" ", "title" = 2)} is the same as \code{c(" " = 1, "title" = 2)}.}
\item{bold}{A T/F value to control whether the text should be bolded.}
diff --git a/man/footnote_marker_number.Rd b/man/footnote_marker_number.Rd
index bc16375..599f284 100644
--- a/man/footnote_marker_number.Rd
+++ b/man/footnote_marker_number.Rd
@@ -20,7 +20,7 @@
default value from global option \code{knitr.table.format}.}
\item{double_escape}{T/F if output is in LaTeX, whether it should be double
-escaped. If you are using footnote_marker in \code{group_rows`` labeling row or}add_header_above\code{, you need to set this to be}TRUE`.}
+escaped. If you are using footnote_marker in \code{group_rows`` labeling row or }add_header_above\code{, you need to set this to be }TRUE`.}
}
\description{
Put footnote mark in superscription in table. Unless you are
diff --git a/man/kable_styling.Rd b/man/kable_styling.Rd
index 608e6f9..a3932fc 100644
--- a/man/kable_styling.Rd
+++ b/man/kable_styling.Rd
@@ -10,7 +10,7 @@
repeat_header_text = "\\\\textit{(continued)}",
repeat_header_method = c("append", "replace"),
repeat_header_continued = FALSE, stripe_color = "gray!6",
- latex_table_env = NULL)
+ latex_table_env = NULL, protect_latex = TRUE)
}
\arguments{
\item{kable_input}{Output of \code{knitr::kable()} with \code{format} specified}
@@ -65,6 +65,9 @@
\item{latex_table_env}{LaTeX option. A character string to define customized
table environment such as tabu or tabularx.You shouldn't expect all features
could be supported in self-defined environments.}
+
+\item{protect_latex}{If \code{TRUE}, LaTeX code embedded between dollar signs
+will be protected from HTML escaping.}
}
\description{
This function provides a cleaner approach to modify the style
@@ -78,6 +81,14 @@
\item all tables are converted to 'UTF-8'. If you use, for example, Hungarian
characters on a Windows machine, make sure to use
Sys.setlocale("LC_ALL","Hungarian") to avoid unexpected conversions.
+\item \code{protect_latex = TRUE} has no effect.
+}
+
+For HTML,
+\itemize{
+\item \code{protect_latex = TRUE} is for including complicated math in HTML output.
+The LaTeX may not include dollar signs even if they are escaped.
+Pandoc's rules for recognizing embedded LaTeX are used.
}
}
\examples{
diff --git a/man/save_kable.Rd b/man/save_kable.Rd
index 0b80071..562ac79 100644
--- a/man/save_kable.Rd
+++ b/man/save_kable.Rd
@@ -4,7 +4,9 @@
\alias{save_kable}
\title{Save kable to files}
\usage{
-save_kable(x, file, bs_theme = "simplex", self_contained = TRUE, ...)
+save_kable(x, file, bs_theme = "simplex", self_contained = TRUE,
+ extra_dependencies = NULL, ..., latex_header_includes = NULL,
+ keep_tex = FALSE)
}
\arguments{
\item{x}{A piece of HTML code for tables, usually generated by kable and
@@ -12,13 +14,26 @@
\item{file}{save to files. If the input table is in HTML and the output file
ends with \code{.png}, \code{.pdf} and \code{.jpeg}, \code{webshot} will be used to do the
-conversion}
+conversion.}
\item{bs_theme}{Which Bootstrap theme to use}
\item{self_contained}{Will the files be self-contained?}
-\item{...}{Additional variables being passed to \code{webshot::webshot}.`}
+\item{extra_dependencies}{Additional HTML dependencies. For example,
+\code{list(}}
+
+\item{...}{Additional variables being passed to \code{webshot::webshot}. This
+is for HTML only.}
+
+\item{latex_header_includes}{A character vector of extra LaTeX header stuff.
+Each element is a row. You can have things like
+\code{c("\\\\usepackage{threeparttable}", "\\\\usepackage{icons}")} You could
+probably add your language package here if you use non-English text in your
+table, such as \code{\\\\usepackage[magyar]{babel}}.}
+
+\item{keep_tex}{A T/F option to control if the latex file that is initially created
+should be kept. Default is \code{FALSE}.}
}
\description{
Save kable to files
diff --git a/man/scroll_box.Rd b/man/scroll_box.Rd
index 440dcc5..1cc6742 100644
--- a/man/scroll_box.Rd
+++ b/man/scroll_box.Rd
@@ -5,7 +5,8 @@
\title{Put a HTML table into a scrollable box}
\usage{
scroll_box(kable_input, height = NULL, width = NULL,
- box_css = "border: 1px solid #ddd; padding: 5px; ", extra_css = NULL)
+ box_css = "border: 1px solid #ddd; padding: 5px; ", extra_css = NULL,
+ fixed_thead = list(enabled = F, background = "#fff"))
}
\arguments{
\item{kable_input}{A HTML kable object}
@@ -17,6 +18,9 @@
\item{box_css}{CSS text for the box}
\item{extra_css}{Extra CSS styles}
+
+\item{fixed_thead}{A list of two named element. enabled and background.
+Default is F and white, e.g. "list(enabled = T, background = "#fff")"}
}
\description{
This function will put a HTML kable object in a fixed-height,