Hao Zhu | b1bc0aa | 2015-11-12 11:23:42 -0500 | [diff] [blame] | 1 | % Generated by roxygen2: do not edit by hand |
| 2 | % Please edit documentation in R/footnote.R |
| 3 | \name{add_footnote} |
| 4 | \alias{add_footnote} |
| 5 | \title{Add footnote} |
| 6 | \usage{ |
Hao Zhu | e10cfd3 | 2017-02-21 16:41:14 -0500 | [diff] [blame] | 7 | add_footnote(input, label = NULL, notation = c("alphabet", "number", |
| 8 | "symbol"), threeparttable = FALSE) |
Hao Zhu | b1bc0aa | 2015-11-12 11:23:42 -0500 | [diff] [blame] | 9 | } |
| 10 | \arguments{ |
| 11 | \item{input}{The direct output of your \code{kable} function or your last |
| 12 | \code{kableExtra} function.} |
| 13 | |
| 14 | \item{label}{A vector of footnotes you want to add. You don't need to add |
| 15 | notations in your notes.} |
| 16 | |
| 17 | \item{notation}{You can select the format of your footnote notation from |
| 18 | "number", "alphabet" and "symbol".} |
Will Beasley | 70aa3b2 | 2016-01-11 11:42:27 -0600 | [diff] [blame] | 19 | |
| 20 | \item{threeparttable}{Boolean value indicating if a \href{https://www.ctan.org/pkg/threeparttable}{threeparttable} scheme should be used.} |
Hao Zhu | b1bc0aa | 2015-11-12 11:23:42 -0500 | [diff] [blame] | 21 | } |
| 22 | \description{ |
| 23 | Add footnote to your favorite kable output. So far this function |
| 24 | only works when you define \code{format} in your kable function or in the |
| 25 | global knitr option \code{knitr.table.format}. In latex, we are using the |
| 26 | \code{threeparttable} package so you need to import this package in your |
| 27 | \code{YAML} header. |
| 28 | } |