Update readme and documentations
diff --git a/man/add_footnote.Rd b/man/add_footnote.Rd
index e2060dd..997e941 100644
--- a/man/add_footnote.Rd
+++ b/man/add_footnote.Rd
@@ -17,7 +17,8 @@
\item{notation}{You can select the format of your footnote notation from
"number", "alphabet" and "symbol".}
-\item{threeparttable}{Boolean value indicating if a \href{https://www.ctan.org/pkg/threeparttable}{threeparttable} scheme should be used.}
+\item{threeparttable}{Boolean value indicating if a
+\href{https://www.ctan.org/pkg/threeparttable}{threeparttable} scheme should be used.}
}
\description{
Add footnote to your favorite kable output. So far this function
diff --git a/man/add_header_above.Rd b/man/add_header_above.Rd
index 54d6884..b65516f 100644
--- a/man/add_header_above.Rd
+++ b/man/add_header_above.Rd
@@ -2,10 +2,22 @@
% Please edit documentation in R/add_header_above.R
\name{add_header_above}
\alias{add_header_above}
-\title{Add an extra header row above the current header}
+\title{Add a header row on top of current header}
\usage{
add_header_above(kable_input, header = NULL)
}
+\arguments{
+\item{kable_input}{Output of `knitr::kable()` with `format` specified}
+
+\item{header}{A (named) character vector with `colspan` as values. For
+example, `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 `colspan` equals to 1, users can drop the ` = 1` part.
+As a result, `c(" ", "title" = 2)` is the same as `c(" " = 1, "title" = 2)`.}
+}
\description{
-Add an extra header row above the current header
+Tables with multiple rows of header rows are extremely useful
+to demonstrate grouped data. This function takes the output of a `kable()`
+function and adds an header row on top of it. This function can work with
+both `HTML` and `LaTeX` outputs
}
diff --git a/man/escape_html.Rd b/man/escape_html.Rd
deleted file mode 100644
index b920921..0000000
--- a/man/escape_html.Rd
+++ /dev/null
@@ -1,14 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/from_knitr.R
-\name{escape_html}
-\alias{escape_html}
-\title{escape special HTML characters}
-\usage{
-escape_html(x)
-}
-\description{
-escape special HTML characters
-}
-\author{
-Yihui Xie
-}
diff --git a/man/escape_latex.Rd b/man/escape_latex.Rd
deleted file mode 100644
index baaa185..0000000
--- a/man/escape_latex.Rd
+++ /dev/null
@@ -1,14 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/from_knitr.R
-\name{escape_latex}
-\alias{escape_latex}
-\title{escape special LaTeX characters}
-\usage{
-escape_latex(x, newlines = FALSE, spaces = FALSE)
-}
-\description{
-escape special LaTeX characters
-}
-\author{
-Yihui Xie
-}
diff --git a/man/kable_styling.Rd b/man/kable_styling.Rd
index 5330f97..08c0e54 100644
--- a/man/kable_styling.Rd
+++ b/man/kable_styling.Rd
@@ -9,17 +9,36 @@
"left", "right", "float_left", "float_right"), font_size = NULL)
}
\arguments{
-\item{bootstrap_options}{A character vector for bootstrap table options. For
-detailed information, please check the package vignette or visit the
-w3schools' \href{https://www.w3schools.com/bootstrap/bootstrap_tables.asp}{Bootstrap Page}
-. Possible options include "basic", "striped", "bordered", "hover",
-"condensed" and "responsive".}
+\item{kable_input}{Output of `knitr::kable()` with `format` specified}
+
+\item{bootstrap_options}{A character vector for bootstrap table options.
+Please see package documentation site or visit the w3schools'
+\href{https://www.w3schools.com/bootstrap/bootstrap_tables.asp}{Bootstrap Page}
+for more information. Possible options include `basic`, `striped`,
+`bordered`, `hover`, `condensed` and `responsive`.}
+
+\item{latex_options}{A character vector for LaTeX table options. Please see
+package documentation site for more information. Possible options include
+`basic`, `striped`, `hold_position`, `scale_down`. `striped` will add
+alternative row colors to the table. It will imports `LaTeX` package `xcolor`
+if enabled. `hold_position` will "hold" the floating table to the exact
+position. It is useful when the `LaTeX` table is contained in a `table`
+environment after you specified captions in `kable()`. It will force the
+table to stay in the position where it was created in the document.
+`scale_down` is useful for super wide table. It will automatically adjust
+the table to page width.}
\item{full_width}{A `TRUE` or `FALSE` variable controlling whether the HTML
-table should have 100\% width.}
+table should have 100\% width. Since HTML and pdf have different flavors on
+the preferable format for `full_width`. If not specified, a HTML table will
+have full width by default but this option will be set to `FALSE` for a
+LaTeX table}
-\item{position}{A character string determining whether and how the HTML table
-should float on the page. Values could be "left", "center", "right"}
+\item{position}{A character string determining how to position the table
+on a page. Possible values include `left`, `center`, `right`, `float_left`
+and `float_right`. Please see the package doc site for demonstrations. For
+a `LaTeX` table, if `float_*` is selected, `LaTeX` package `wrapfig` will be
+imported.}
\item{font_size}{A numeric input for table font size}
}
diff --git a/man/magic_mirror.Rd b/man/magic_mirror.Rd
index 1d468b8..56b3f79 100644
--- a/man/magic_mirror.Rd
+++ b/man/magic_mirror.Rd
@@ -4,11 +4,11 @@
\alias{magic_mirror}
\title{Magic mirror that returns kable's attributes}
\usage{
-magic_mirror(input)
+magic_mirror(kable_input)
}
\arguments{
-\item{input}{The output of kable}
+\item{kable_input}{The output of kable}
}
\description{
-Magic mirror that returns kable's attributes
+Mirror mirror tell me, how does this kable look like?
}
diff --git a/man/magic_mirror_html.Rd b/man/magic_mirror_html.Rd
index 1baedfc..0c05b1c 100644
--- a/man/magic_mirror_html.Rd
+++ b/man/magic_mirror_html.Rd
@@ -4,10 +4,10 @@
\alias{magic_mirror_html}
\title{Magic Mirror for html table --------}
\usage{
-magic_mirror_html(input)
+magic_mirror_html(kable_input)
}
\arguments{
-\item{input}{The output of kable}
+\item{kable_input}{The output of kable}
}
\description{
Magic Mirror for html table --------
diff --git a/man/magic_mirror_latex.Rd b/man/magic_mirror_latex.Rd
index 0550aa1..5bc299c 100644
--- a/man/magic_mirror_latex.Rd
+++ b/man/magic_mirror_latex.Rd
@@ -4,10 +4,10 @@
\alias{magic_mirror_latex}
\title{Magic mirror for latex tables --------------}
\usage{
-magic_mirror_latex(input)
+magic_mirror_latex(kable_input)
}
\arguments{
-\item{input}{The output of kable}
+\item{kable_input}{The output of kable}
}
\description{
Magic mirror for latex tables --------------