tabl: Add a Table to an RTF Document

View source: R/tabl.R

tablR Documentation

Add a Table to an RTF Document

Description

Add a table to an rtf (rich text format) document.

Usage

tabl(
  ...,
  TAB = tab,
  rtf = doc,
  fontt = 8,
  row.names = TRUE,
  tabc = GLFCenv$tabcount,
  boldt = TRUE,
  newpage = "none",
  omi = c(1, 1, 1, 1)
)

Arguments

...

One or more character scalars (separated by commas) of text to use for the table caption.

TAB

A matrix, data frame, or table to be added to the document as a table, default tab.

rtf

An rtf object, default doc.

fontt

Numeric scalar font size for table caption, default 8.

row.names

Logical scalar whether to include the row.names of TAB in the table, default TRUE.

tabc

Numeric scalar table number to use in caption, default GLFCenv$tabcount.

boldt

Logical scalar indicating if table number should use bold font, default TRUE.

newpage

Character scalar indicating if the table should start on a new page in the document "port" for a new portrait page, "land" for a new landscape page, and "none" for no new page (the default).

omi

Numeric vector, length 4, width of document page margins in inches (bottom, left, top, right), default c(1, 1, 1, 1).

Details

The table and caption are written to the rtf file. The size of a new page is assumed to be 8.5 by 11 inches.

Value

A 1 is added to the numeric vector of length 1, GLFCenv$tabcount, stored in the working directory to keep track of the number of tables written to the rtf document, and label the captions accordingly.

See Also

startrtf for an example, heading, para, figu, figbig, endrtf, RTF.


JVAdams/GLFC documentation built on Jan. 5, 2023, 12:59 a.m.