st_hline: Add hline information to st object

View source: R/table-object.R

st_hlineR Documentation

Add hline information to st object

Description

See the hline_at and hline_from arguments passed to stable() and then to tab_hlines(),

Usage

st_hline(
  x,
  pattern = NULL,
  cols = names(x$data),
  n = 1,
  at = NULL,
  from = NULL,
  nudge = 0
)

Arguments

x

and stobject

pattern

a regular expression to find rows where an hline will be placed; passed to stringr::str_detect()

cols

data columns to scan using pattern

n

number of hlines to add when a hit is found

at

logical or integer locations for hline passed to stable() as hline_at

from

character column name used to divide a table; passed to stable() as hline_from

nudge

push an hline down or up in the table; only applies to indices found from using either the at or pattern arguments


metrumresearchgroup/pmtables documentation built on Dec. 22, 2024, 1:34 a.m.