Table with footnotes

Source: R/include_table.R

Include tables with notes and titles for word and html documents

include_table(
  data = NULL,
  caption = NA,
  notes = NA,
  label = NA,
  notation = "none"
)

Arguments

data

Data frame.
caption

Table caption (default = NULL). See details.
notes

Footnotes for the table (default = NA). See details.
label

Label for start the footnote (default = NA).
notation

Notation for the symbols and footnotes (default = "none"). See details.

Value

Table with caption and footnotes

Details

For caption and notes you can include caption and notes in the last rows of your data frame. Where the information will be extracted automatically for include in the formatted table. You can add the footnote symbol using {hypen} in your table. notation could be use: "alphabet", "number", "none".

Examples


library(inti)

tab <- data.frame(
x = rep_len(1, 5)
, y = rep_len(3, 5)
, z = rep_len("c", 5)
)

table <- tab %>% 
info_table(
  caption = "Figure caption"
  , notes = "test note"
  )

table %>% inti::include_table()

#> 
#> 
#> Table: Figure caption
#> 
#> |  x|  y|z  |
#> |--:|--:|:--|
#> |  1|  3|c  |
#> |  1|  3|c  |
#> |  1|  3|c  |
#> |  1|  3|c  |
#> |  1|  3|c  |
#> 
#> 
#> <small>test note</small>