topic_long_table_caption: Generate a LaTeX table caption

In billdenney/TopicLongTableR: Create LaTeX Tables Using the topiclongtable CTAN Package

Generate a LaTeX table caption

Description

Generate a LaTeX table caption

Usage

topic_long_table_caption(
  x,
  text = NULL,
  label = NULL,
  combine_short_long = TRUE,
  latex_clean = TRUE,
  verbatim = NULL
)

Arguments

x	The object to make into a topiclongtable (typically a data.frame or matrix)
text	Text to place in the caption. See Details.
label	The label for the caption
combine_short_long	Should the short and long captions be combined for the long caption? See Details.
latex_clean	Should cleaning occur? Cleaning is: If a data.frame or matrix, the contents are run through Hmisc::latexTranslate(format(x)) prior to generating the table body.
verbatim	Use the provided character scalar verbatim without other processing.

Details

For text, if NULL, the caption attribute for x will be used, if it exists. If neither is provided, the caption will be an empty string (i.e. no caption). If the length of the character vector for the caption text (as defined earlier in this paragraph) is 1, the caption will be used as-is; if the length is 2 and combine_short_long == TRUE, then the first element will be used as the short caption and the first and second will be pasted together for the long caption.

Value

The caption for inclusion in a table or an empty string if no caption is provided.

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