Learn R Programming

rfriend (version 1.0.0)

f_pander: Fancy Pander Table Output

Description

Is a wrapper around the pander function from the 'pander' package, designed to produce a fancy table output with specific formatting options.

Usage

f_pander(table, col_width = 10, table_width = NULL, ...)

Value

None. The function is called for its side effects of setting 'pander' options and creates a pander formatted table in R Markdown.

Arguments

table

A data frame, matrix, or other table-like structure to be rendered.

col_width

Integer. Specifies the maximum number of characters allowed in table header columns before a line break is inserted. Defaults to 10.

table_width

Integer or NULL. Defines the number of characters after which the table is split into separate sections. Defaults to NULL, meaning no break is applied.

...

Additional arguments passed to the pander function.

Author

Sander H. van Delden plantmind@proton.me

Details

This function sets several pander options to ensure that the table output is formatted in a visually appealing manner. The options set include:

  • table.alignment.default: Aligns all columns to the left.

  • table.alignment.rownames: Aligns row names to the left.

  • keep.trailing.zeros: Keeps trailing zeros in numeric values.

  • knitr.auto.asis: Ensures output is not automatically treated as 'asis'.

  • table.split.table: Prevents splitting of tables across pages or slides.

  • table.caption.prefix: Removes the default "Table" prefix in captions.

This function requires [Pandoc](https://github.com/jgm/pandoc/releases/tag) (version 1.12.3 or higher), a universal document converter.

  • Windows: Install Pandoc and ensure the installation folder
    (e.g., "C:/Users/your_username/AppData/Local/Pandoc") is added to your system PATH.

  • macOS: If using Homebrew, Pandoc is typically installed in "/usr/local/bin". Alternatively, download the .pkg installer and verify that the binary’s location is in your PATH.

  • Linux: Install Pandoc through your distribution’s package manager (commonly installed in "/usr/bin" or "/usr/local/bin") or manually, and ensure the directory containing Pandoc is in your PATH.

  • If Pandoc is not found, this function may not work as intended.

Examples

Run this code
# Example usage of f_pander
df <- data.frame(
  Name = c("Alice", "Bob", "Charlie"),
  Age = c(25, 30, 35),
  Score = c(88.5, 92.3, 85.0)
)

# Render the data frame as a fancy table
f_pander(df)

Run the code above in your browser using DataLab