Skip to contents

Markdown tables

Source: R/AllGenerics.R, R/markdownTables-methods.R
markdownTables.Rd

Markdown tables

Usage

markdownTables(object, ...)

# S4 method for list
markdownTables(object, captions = NULL, force = FALSE)

Arguments

object

Object.

captions

character or NULL. Captions. If NULL, the names of the primary input list will be used automatically.

force

logical(1). Force knit output using knitr::asis_output(). Recommended for development and unit testing only.

...

Additional arguments.

Value

  • knit call: asis_output

  • Otherwise: list.

Details

knitr::kable() now supports multiple tables as a list for the x argument, but it still only supports a single caption. markdownTables extends this functionality, but supporting captions for each table.

Note

Updated 2022-05-24.

See also

Examples

list <- list(
    "iris" = head(datasets::iris),
    "mtcars" = head(datasets::mtcars)
)
captions <- c(
    "iris" = "Edgar Anderson's iris data",
    "mtcars" = "Motor Trend car road tests"
)
markdownTables(list, captions = captions)
#> $iris
#>   Sepal.Length Sepal.Width Petal.Length Petal.Width Species
#> 1          5.1         3.5          1.4         0.2  setosa
#> 2          4.9         3.0          1.4         0.2  setosa
#> 3          4.7         3.2          1.3         0.2  setosa
#> 4          4.6         3.1          1.5         0.2  setosa
#> 5          5.0         3.6          1.4         0.2  setosa
#> 6          5.4         3.9          1.7         0.4  setosa
#> 
#> $mtcars
#>                    mpg cyl disp  hp drat    wt  qsec vs am gear carb
#> Mazda RX4         21.0   6  160 110 3.90 2.620 16.46  0  1    4    4
#> Mazda RX4 Wag     21.0   6  160 110 3.90 2.875 17.02  0  1    4    4
#> Datsun 710        22.8   4  108  93 3.85 2.320 18.61  1  1    4    1
#> Hornet 4 Drive    21.4   6  258 110 3.08 3.215 19.44  1  0    3    1
#> Hornet Sportabout 18.7   8  360 175 3.15 3.440 17.02  0  0    3    2
#> Valiant           18.1   6  225 105 2.76 3.460 20.22  1  0    3    1
#>