print_screen {huxtable}R Documentation

Print a huxtable on screen

Description

Print a huxtable on screen

Usage

print_screen(ht, ...)

to_screen(ht, ...)

## S3 method for class 'huxtable'
to_screen(ht, min_width = ceiling(getOption("width")/6),
  max_width = getOption("width", Inf), compact = TRUE, colnames = TRUE,
  color = getOption("huxtable.color_screen", default = TRUE), ...)

Arguments

ht

A huxtable.

...

Passed on to to_screen.

min_width

Minimum width in on-screen characters of the result.

max_width

Maximum width in on-screen characters of the result. Overrides min_width.

compact

Logical. To save space, don't print lines for empty horizontal borders.

colnames

Logical. Whether or not to print colum names.

color

Logical. Whether to print the huxtable in color (requires the crayon package).

Details

colspan, rowspan, align and caption properties are shown. If the crayon package is installed, output will be colorized (and contents bolded or italicized) by default; this will work in recent daily builds of RStudio as of October 2017.

Value

to_screen returns a string. print_screen prints the string and returns NULL.

See Also

Other printing functions: print_html, print_latex, print_md

Examples

ht <- huxtable(a = 1:5, b = 1:5, add_colnames = TRUE)
ht <- set_all_borders(ht, 1:6, 1:2, 1)
right_border(ht)[,1] <- left_border(ht)[,2] <- 0
align(ht)[1,] <- 'left'
print_screen(ht)
[Package huxtable version 4.0.1 Index]