Skip to contents

Generic export of data frames into formatted tables

Source: R/display.R
display.Rd

display() is a generic function to export data frames into various table formats (like plain text, markdown, ...). print_md() usually is a convenient wrapper for display(format = "markdown"). Similar, print_html() is a shortcut for display(format = "html"). See the documentation for the specific objects' classes.

Usage

display(object, ...)

print_md(x, ...)

print_html(x, ...)

# S3 method for class 'data.frame'
display(object, format = "markdown", ...)

# S3 method for class 'data.frame'
print_md(x, ...)

# S3 method for class 'data.frame'
print_html(x, ...)

Arguments

object, x

A data frame.

...

Arguments passed to other methods.

format

String, indicating the output format. Can be "markdown" or "html". A special option is "tt", which creates a tinytable::tt() object, where the output format is dependent on the context where the table is used, i.e. it can be markdown format when export_table() is used in markdown files, or LaTex format when creating PDFs etc.

Value

Depending on format, either an object of class gt_tbl, tinytable, or a character vector of class knitr_kable.

Global Options to Customize Output when Printing

  • options(easystats_display_format = <value>) will set the default format for the display() methods. Can be one of "markdown", "html", or "tt". See display() for details.

  • options(easystats_table_width = <value>) sets the default width for tables printed to the console. Tables exceeding this width are wrapped into multiple parts to ensure clean formatting and avoid excessively long lines.

  • options(easystats_ci_separator = <value>) defines the separator string used between the lower and upper CI limits. Defaults to ", ", resulting in an output like [0.3, 0.8].

  • options(easystats_ci_brackets = <value>) determines whether brackets or parentheses are used to enclose formatted CIs. Can be FALSE to omit them, TRUE to include them (defaults to [ and ] for text output), or a character vector of length 2 to define custom opening and closing symbols (e.g., c("(", ")")).

  • options(insight_use_symbols = <value>) accepts TRUE or FALSE. If TRUE, statistical symbols (e.g., eta-squared, omega) are rendered using their corresponding Unicode characters.

Examples

display(iris[1:5, ], format = "html")



  
Sepal.Length
      Sepal.Width
      Petal.Length
      Petal.Width
      Species
    
5.10
3.50
1.40
0.20
setosa
4.90
3.00
1.40
0.20
setosa
4.70
3.20
1.30
0.20
setosa
4.60
3.10
1.50
0.20
setosa
5.00
3.60
1.40
0.20
setosa

display(iris[1:5, ], format = "tt")
#> 
#> +--------------+-------------+--------------+-------------+---------+
#> | Sepal.Length | Sepal.Width | Petal.Length | Petal.Width | Species |
#> +==============+=============+==============+=============+=========+
#> | 5.10         | 3.50        | 1.40         | 0.20        | setosa  |
#> +--------------+-------------+--------------+-------------+---------+
#> | 4.90         | 3.00        | 1.40         | 0.20        | setosa  |
#> +--------------+-------------+--------------+-------------+---------+
#> | 4.70         | 3.20        | 1.30         | 0.20        | setosa  |
#> +--------------+-------------+--------------+-------------+---------+
#> | 4.60         | 3.10        | 1.50         | 0.20        | setosa  |
#> +--------------+-------------+--------------+-------------+---------+
#> | 5.00         | 3.60        | 1.40         | 0.20        | setosa  |
#> +--------------+-------------+--------------+-------------+---------+ 

display(iris[1:5, ], format = "markdown")
#> 
#> 
#> | Sepal.Length| Sepal.Width| Petal.Length| Petal.Width| Species|
#> |------------:|-----------:|------------:|-----------:|-------:|
#> |         5.10|        3.50|         1.40|        0.20|  setosa|
#> |         4.90|        3.00|         1.40|        0.20|  setosa|
#> |         4.70|        3.20|         1.30|        0.20|  setosa|
#> |         4.60|        3.10|         1.50|        0.20|  setosa|
#> |         5.00|        3.60|         1.40|        0.20|  setosa|