Hao Zhu | b1bc0aa | 2015-11-12 11:23:42 -0500 | [diff] [blame] | 1 | % Generated by roxygen2: do not edit by hand |
Hao Zhu | a3fc0c4 | 2017-02-27 12:04:59 -0500 | [diff] [blame] | 2 | % Please edit documentation in R/add_footnote.R |
Hao Zhu | b1bc0aa | 2015-11-12 11:23:42 -0500 | [diff] [blame] | 3 | \name{add_footnote} |
| 4 | \alias{add_footnote} |
| 5 | \title{Add footnote} |
| 6 | \usage{ |
Hao Zhu | 9410a27 | 2020-08-03 01:11:47 -0400 | [diff] [blame] | 7 | add_footnote( |
| 8 | input, |
| 9 | label = NULL, |
| 10 | notation = "alphabet", |
| 11 | threeparttable = FALSE, |
| 12 | escape = TRUE |
| 13 | ) |
Hao Zhu | b1bc0aa | 2015-11-12 11:23:42 -0500 | [diff] [blame] | 14 | } |
| 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 |
| 20 | notations in your notes.} |
| 21 | |
| 22 | \item{notation}{You can select the format of your footnote notation from |
Hao Zhu | b8b0cae | 2018-04-11 16:27:13 -0400 | [diff] [blame] | 23 | \code{number}, \code{alphabet}, \code{symbol} and \code{none}.} |
Will Beasley | 70aa3b2 | 2016-01-11 11:42:27 -0600 | [diff] [blame] | 24 | |
Hao Zhu | f7994dd | 2017-02-27 16:58:42 -0500 | [diff] [blame] | 25 | \item{threeparttable}{Boolean value indicating if a |
Hao Zhu | 78e6122 | 2017-05-24 20:53:35 -0400 | [diff] [blame] | 26 | \href{https://www.ctan.org/pkg/threeparttable}{threeparttable} scheme should |
| 27 | be used.} |
Hao Zhu | 53e240f | 2017-09-04 20:04:29 -0400 | [diff] [blame] | 28 | |
| 29 | \item{escape}{Logical value controlling if the label needs to be escaped. |
| 30 | Default is TRUE.} |
Hao Zhu | b1bc0aa | 2015-11-12 11:23:42 -0500 | [diff] [blame] | 31 | } |
| 32 | \description{ |
Hao Zhu | e7c8f70 | 2017-10-10 13:22:59 -0400 | [diff] [blame] | 33 | Add footnote to your favorite kable output. |
Hao Zhu | b1bc0aa | 2015-11-12 11:23:42 -0500 | [diff] [blame] | 34 | } |
Hao Zhu | 78e6122 | 2017-05-24 20:53:35 -0400 | [diff] [blame] | 35 | \examples{ |
Hao Zhu | 9399dcc | 2020-08-26 17:27:38 -0400 | [diff] [blame^] | 36 | \dontrun{ |
Hao Zhu | 78e6122 | 2017-05-24 20:53:35 -0400 | [diff] [blame] | 37 | x <- knitr::kable(head(mtcars), "html") |
| 38 | add_footnote(x, c("footnote 1", "footnote 2"), notation = "symbol") |
Hao Zhu | 9399dcc | 2020-08-26 17:27:38 -0400 | [diff] [blame^] | 39 | } |
Hao Zhu | 78e6122 | 2017-05-24 20:53:35 -0400 | [diff] [blame] | 40 | |
| 41 | } |