figu: Add a Figure to an RTF Document

In JVAdams/GLFC: Great Lakes Fishery Commission

Add a Figure to an RTF Document

Description

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

Usage

figu(
  ...,
  FIG = fig,
  rtf = doc,
  figid = "Figure ",
  fign = GLFCenv$figcount,
  boldt = TRUE,
  capunder = TRUE,
  w = NULL,
  h = NULL,
  rf = 300,
  newpage = "none",
  omi = c(1, 1, 1, 1)
)

Arguments

...	One or more character scalars (separated by commas) of text to use for the figure caption.
FIG	A function to create a figure which will be added to the document, default fig.
rtf	An rtf object, default doc.
figid	Character scalar of caption identifier, default "Figure ".
fign	Numeric scalar of figure number to use in caption, default GLFCenv$figcount.
boldt	Logical scalar indicating if figure number should use bold font, default TRUE.
capunder	Logical scalar indicating if caption should appear under the figure (TRUE, the default) or on top of the figure (FALSE).
w	Numeric scalar width of figure in inches, default 6.5.
h	Numeric scalar height of figure in inches, default 8.
rf	Numeric scalar resolution of figure, default 300.
newpage	Character scalar indicating if the figure 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 figure 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$figcount, stored in the working directory to keep track of the number of figures written to the rtf document, and label the captions accordingly.

See Also

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

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