blob: 17122b1a38691c74cb37f82f717483e77adfd1eb [file] [log] [blame]
Hao Zhub1bc0aa2015-11-12 11:23:42 -05001% 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 Zhu8977a8a2015-11-19 16:52:21 -05007add_footnote(input, label = NULL, notation = "alphabet",
8 threeparttable = F)
Hao Zhub1bc0aa2015-11-12 11:23:42 -05009}
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
15notations in your notes.}
16
17\item{notation}{You can select the format of your footnote notation from
18"number", "alphabet" and "symbol".}
19}
20\description{
21Add footnote to your favorite kable output. So far this function
22only works when you define \code{format} in your kable function or in the
23global knitr option \code{knitr.table.format}. In latex, we are using the
24\code{threeparttable} package so you need to import this package in your
25\code{YAML} header.
26}
27