blob: 525ce262c0b7f9181d9b7590c69194970eabdccc [file] [log] [blame]
Hao Zhub1bc0aa2015-11-12 11:23:42 -05001% Generated by roxygen2: do not edit by hand
Hao Zhua3fc0c42017-02-27 12:04:59 -05002% Please edit documentation in R/add_footnote.R
Hao Zhub1bc0aa2015-11-12 11:23:42 -05003\name{add_footnote}
4\alias{add_footnote}
5\title{Add footnote}
6\usage{
Hao Zhu9410a272020-08-03 01:11:47 -04007add_footnote(
8 input,
9 label = NULL,
10 notation = "alphabet",
11 threeparttable = FALSE,
12 escape = TRUE
13)
Hao Zhub1bc0aa2015-11-12 11:23:42 -050014}
15\arguments{
16\item{input}{The direct output of your \code{kable} function or your last
17\code{kableExtra} function.}
18
19\item{label}{A vector of footnotes you want to add. You don't need to add
20notations in your notes.}
21
22\item{notation}{You can select the format of your footnote notation from
Hao Zhub8b0cae2018-04-11 16:27:13 -040023\code{number}, \code{alphabet}, \code{symbol} and \code{none}.}
Will Beasley70aa3b22016-01-11 11:42:27 -060024
Hao Zhuf7994dd2017-02-27 16:58:42 -050025\item{threeparttable}{Boolean value indicating if a
Hao Zhu78e61222017-05-24 20:53:35 -040026\href{https://www.ctan.org/pkg/threeparttable}{threeparttable} scheme should
27be used.}
Hao Zhu53e240f2017-09-04 20:04:29 -040028
29\item{escape}{Logical value controlling if the label needs to be escaped.
30Default is TRUE.}
Hao Zhub1bc0aa2015-11-12 11:23:42 -050031}
32\description{
Hao Zhue7c8f702017-10-10 13:22:59 -040033Add footnote to your favorite kable output.
Hao Zhub1bc0aa2015-11-12 11:23:42 -050034}
Hao Zhu78e61222017-05-24 20:53:35 -040035\examples{
36x <- knitr::kable(head(mtcars), "html")
37add_footnote(x, c("footnote 1", "footnote 2"), notation = "symbol")
38
39}