topic_long_table_header: Generate the table header or footer

View source: R/topic_long_table_header_footer.R

topic_long_table_headerR Documentation

Generate the table header or footer

Description

Generate the table header or footer

Usage

topic_long_table_header(
  x,
  col_names = NULL,
  above_col_names = "\\hline",
  below_col_names = "\\hline",
  subsequent_page_notification = "\\ldots continued",
  latex_header = NULL,
  verbatim = NULL
)

topic_long_table_footer(
  x,
  bottom_border = "\\hline",
  bottom_all_pages = NULL,
  bottom_last_page = NULL,
  subsequent_page_notification = "continued \\ldots",
  verbatim = NULL
)

Arguments

x

The object to generate the header for.

col_names

The column names to use for the table header (defaults to Hmisc::latexTranslate(colnames(x)) if NULL). This must have the same length as ncol(x).

above_col_names, below_col_names

LaTeX text to place above/below the col_names text (typically this will be a horizontal line with "\hline").

subsequent_page_notification

LaTeX text to place above the subsequent page headers

latex_header

A fully-defined LaTeX header to use in place of the auto-generated header. (If a character scalar, it is returned as-is; if character a vector, it is joined with " \\\n" separating the elements.)

verbatim

Use the provided character scalar verbatim without other processing.

bottom_border

The border below the tabular text on all pages.

bottom_all_pages, bottom_last_page

LaTeX text below the bottom border on all (including the last) or only the last page, respectively.

Value

A character string of table header for a topic_long_table (a single string, not a vector).

Functions

  • topic_long_table_footer(): Generate the footer.


billdenney/TopicLongTableR documentation built on Aug. 27, 2023, 10:16 p.m.