RPGM 2.0 Docs

Report R functions

This set of functions can add new report elements to an existing report step in the program.

report.addTitle(step, position, text, style = “section”, toc = “toc”)

Add a new title to a report.

  • step is a step object created by `rpgm.step`
  • position is the position of the new element. 0 is for placing the element in the first position
  • text is the text of the title
  • style is the style of the title. Correct values are section, subsection, subsubsection, paragraph and subparagraph
  • toc indicates how the title appears in the Table of Contents. Valid values are numtoc, toc or null

See also the manual page for the Reports for further details.

report.addText(step, position, text)

Add a new text to a report.

  • step is a step object created by `rpgm.step`
  • position is the position of the new element. 0 is for placing the element in the first position
  • text is the text to add

See also the manual page for the Reports for further details.

report.addTable(step, position, value, id = “”, caption = “”, fullStyle = FALSE, align = ‘l’, firstCell = “”)

Add a new table to a report.

  • step is a step object created by `rpgm.step`
  • position is the position of the new element. 0 is for placing the element in the first position
  • value is the R variable representing the table to insert
  • id is the unique LaTeX identifier for later use
  • caption is a small text under the table
  • fullStyle will display lines between rows if set to TRUE
  • align specify the text alignment of the first column. Valid values are l for left, c for centered and r for right alignment
  • firstCell is a text for the first top-left cell of the table

See also the manual page for the Reports for further details.

report.addImage(step, position, path, id = “”, caption = “”, scale = 1.0)

Add a new image to a report.

  • step is a step object created by `rpgm.step`
  • position is the position of the new element. 0 is for placing the element in the first position
  • path is the path of the image
  • id is the unique LaTeX identifier for later use
  • caption is a small text under the image
  • scale is the scale multiplier of the image. 1.0 is the original image size

See also the manual page for the Reports for further details.

report.addEquation(step, position, equation, id = “”, numbered = TRUE)

Add a new equation to a report.

  • step is a step object created by `rpgm.step`
  • position is the position of the new element. 0 is for placing the element in the first position
  • equation is the equation represented in text
  • id is the unique LaTeX identifier for later use
  • numbered will indicate if the equation should have a number for future references

See also the manual page for the Reports for further details.

report.addNewPage(step, position)

Add a new page break to a report.

  • step is a step object created by `rpgm.step`
  • position is the position of the new element. 0 is for placing the element in the first position

See also the manual page for the Reports for further details.

report.addVSpace(step, position, spacevalue)

Add a new vertical space to a report.

  • step is a step object created by `rpgm.step`
  • position is the position of the new element. 0 is for placing the element in the first position
  • spacevalue is the value of the space in centimeters

See also the manual page for the Reports for further details.