Table information

Source: R/info_table.R

Add table information for include_table

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

Arguments

data

Data frame
caption

Table caption.
notes

Table notes.
label

Note label.
notation

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

Value

data frame

Details

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$info

#>            x              y    z
#> 1          1              3    c
#> 2          1              3    c
#> 3          1              3    c
#> 4          1              3    c
#> 5          1              3    c
#> 6  {caption} Figure caption <NA>
#> 7    {notes}      test note <NA>
#> 8    {label}           <NA> <NA>
#> 9 {notation}           none <NA>