huxtable (version 4.7.1)

left_border: Borders

Description

Functions to get or set the borders property of huxtable cells.

Usage

left_border(ht)
left_border(ht) <- value
set_left_border(ht, row, col, value, byrow = FALSE)
map_left_border(ht, row, col, fn)
right_border(ht)
right_border(ht) <- value
set_right_border(ht, row, col, value, byrow = FALSE)
map_right_border(ht, row, col, fn)
top_border(ht)
top_border(ht) <- value
set_top_border(ht, row, col, value, byrow = FALSE)
map_top_border(ht, row, col, fn)
bottom_border(ht)
bottom_border(ht) <- value
set_bottom_border(ht, row, col, value, byrow = FALSE)
map_bottom_border(ht, row, col, fn)

Arguments

ht

A huxtable.

value

A numeric vector or matrix giving border widths in points. Set to 0 for no border.

Set to NA to reset to the default, which is 0.

row

A row specifier. See rowspecs for details.

col

An optional column specifier.

fn

A mapping function. See mapping-functions for details.

byrow

Deprecated. Use by_cols() instead.

Value

For left_border, the left_border property. For set_left_border and map_left_border, the modified huxtable.

Similarly for the other functions.

Details

Currently in LaTeX, all non-zero border widths on a given line must be the same, and vertical border widths can only be present (if value > 0) or absent.

See Also

set_all_borders()

Examples

# NOT RUN {
orig <- left_border(jams)
left_border(jams) <-  1
left_border(jams)
jams
left_border(jams) <- orig

set_left_border(jams, 1)
set_left_border(jams,
      2:3, 1, 1)
map_left_border(jams,
      by_rows(1, 0))
# When cells span multiple rows:
ht <- tribble_hux(
  ~Col1,                   ~Col2,
  "Cell 1,1 spans 2 rows", "Cell 1,2",
  "Cell 2,1 is invisible", "Cell 2,2"
)

rowspan(ht)[1, 1] <- 2
ht

bottom_border(ht)[2, ] <- 1
bottom_border_color(ht)[2, ] <- 'red'

# Cell 1, 1 does not have a border set:
ht

# Fixed:
bottom_border(ht)[1, 1] <- 1
bottom_border_color(ht)[1, 1] <- 'red'
ht
# }