pander (version 0.3.1)

pandoc.table.return: Create a table

Description

Creates a Pandoc's markdown style table with optional caption.

Usage

pandoc.table.return(t, caption = storage$caption,
    digits = panderOptions("digits"),
    decimal.mark = panderOptions("decimal.mark"),
    round = panderOptions("round"), justify = "centre",
    style = c("multiline", "grid", "simple"),
    split.tables = panderOptions("table.split.table"),
    split.cells = panderOptions("table.split.cells"))

Arguments

t

data frame, matrix or table

caption

string

digits

passed to format

decimal.mark

passed to format

round

passed to round

justify

see prettyNum

style

which Pandoc style to use: simple, multiline or grid

split.tables

where to split wide tables to separate tables. The default value (80) suggests the conventional number of characters used in a line, feel free to change (e.g. to Inf to disable this feature) if you are not using a VT100 t

split.cells

where to split cells' text with line breaks. Default to 30, to disable set to Inf.

Value

• By default this function outputs (see: cat) the result. If you would want to catch the result instead, then call the function ending in .return.

Details

This function will try to make pretty the provided R object's content like: rounding numbers, auto-recognizing if row names should be included etc.

And also tries to split cells with line breaks or even the whole table to separate parts on demand. See the parameters above.

References

John MacFarlane (2012): _Pandoc User's Guide_. http://johnmacfarlane.net/pandoc/README.html

See Also

set.caption

Examples

pandoc.table(mtcars)

## caption
pandoc.table(mtcars, 'Motor Trend Car Road Tests')

## other input/output formats
pandoc.table(mtcars[, 1:3], decimal.mark = ',')
pandoc.table(mtcars[, 1:3], decimal.mark = ',', justify = 'right')
pandoc.table(matrix(sample(1:1000, 25), 5, 5))
pandoc.table(matrix(runif(25), 5, 5))
pandoc.table(matrix(runif(25), 5, 5), digits = 5)
pandoc.table(matrix(runif(25),5,5), round = 1)
pandoc.table(table(mtcars$am))
pandoc.table(table(mtcars$am, mtcars$gear))
pandoc.table(table(state.division, state.region))
pandoc.table(table(state.division, state.region), justify = 'centre')

m <- data.frame(a=c(1, -500, 10320, 23, 77), b=runif(5), c=c('a', 'bb', 'ccc', 'dddd', 'eeeee'))
pandoc.table(m)
pandoc.table(m, justify = c('right', 'left', 'centre'))

## splitting up too wide tables
pandoc.table(mtcars)
pandoc.table(mtcars, caption = 'Only once after the first part!')

## tables with line breaks in cells
## Note: line breaks are removed from table content and added automatically based on "split.cells" parameter!
t <- data.frame(a = c('hundreds\nof\nmouses', '3 cats'), b=c('FOO is nice', 'BAR\nBAR2'))
pandoc.table(t)
pandoc.table(t, split.cells = 5)

## exporting tables in other Pandoc styles
pandoc.table(m)
pandoc.table(m, style = "grid")
pandoc.table(m, style = "simple")
pandoc.table(t, style = "grid")
pandoc.table(t, style = "grid", split.cells = 5)
pandoc.table(t, style = "simple")
tryCatch(pandoc.table(t, style = "simple", split.cells = 5), error = function(e) 'Yeah, no newline support in simple tables')