tabl: Add a Table to an RTF Document

In JVAdams/EchoNet2Fish: Estimate Fish Abundance from Acoustic Echoes and Net Catch

Description

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

Usage

tabl(
  ...,
  TAB = tab,
  rtf = doc,
  fontt = 8,
  row.names = TRUE,
  tabc = EchoEnv$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 EchoEnv$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, EchoEnv$tabcount, stored in the working directory to keep track of the number of tables written to the rtf document, and label the captions accordingly.

References

This is a copy of the tabl function from the [GLFC] package.

See Also

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

JVAdams/EchoNet2Fish documentation built on Feb. 15, 2021, 4:27 a.m.