blob: fe90a868c18be7f26c31d49d77b05f61135ccfcb [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 Zhu2203f662015-11-20 11:53:39 -05007add_footnote(input, label = NULL, notation = "number",
8 threeparttable = FALSE)
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".}
Will Beasley70aa3b22016-01-11 11:42:27 -060019
20\item{threeparttable}{Boolean value indicating if a \href{https://www.ctan.org/pkg/threeparttable}{threeparttable} scheme should be used.}
Hao Zhub1bc0aa2015-11-12 11:23:42 -050021}
22\description{
23Add footnote to your favorite kable output. So far this function
24only works when you define \code{format} in your kable function or in the
25global 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}
29