annotate.page: annotate.page

Description

Optionally adds up to 4 lines for titles, 3 lines for right and left headers, and 5 lines of footnotes

Usage

annotate.page(
  page.height = 8.5,
  page.width = 11,
  top.margin = 1 - 0.5,
  bottom.margin = 1 - 0.5,
  right.margin = 0.75,
  left.margin = 0.75,
  foot.size = 10,
  head.size = 10,
  title.size = 14,
  add.fignum = TRUE,
  fnote.buffer = 0,
  header.buffer = 0,
  fignum.buffer = 1,
  title.buffer = 2,
  fignum = "1.100",
  title = list("If ggplot populates title, annotate.page's title argument gets a ",
    "list of whitespace text strings. If annotate.page is populating titles,",
    "use whitespaces and newline escape characters in ggplot titles",
    "to ensure ggplot object is shrunken titles do not stamp over your graphs"),
  ulh = list("Upper Left Header 1", "Upper Left Header 2", "Upper Left Header 3"),
  urh = list("Upper Right Header 1", "Upper Right Header 2", "Upper Right Header 3"),
  fnote = list("Footnote1: Up to five lines of footnotes can be annotated.",
    "Footnote2: Graphic region height can be flexed.", "Footnote3", "Footnote4",
    "Footnote5: In large-scale production, this may hold file name, time stamp, etc."),
  override = "",
  addTime = TRUE
)

Value

Following an application of build.page, this function stamps on meta-data.

Arguments

page.height: used by build.page and annotate.page; presumed to be inches
page.width: used by build.page and annotate.page; presumed to be inches
top.margin: used by build.page and annotate.page; presumed to be inches
bottom.margin: used by build.page and annotate.page
right.margin: used by build.page and annotate.page; presumed to be inches
left.margin: used by build.page and annotate.page; presumed to be inches
foot.size: default: 10; passed to grid.text via gp (annotate.page)
head.size: default: 10 (anotate.page)
title.size: default: 14; passed to grid.text via gp (annotate.page)
add.fignum: logical (annotate.page)
fnote.buffer: fine-control of vertical position (annotate.page)
header.buffer: fine-control of vertical position (anotate.page)
fignum.buffer: fine-control of vertical position (annotate.page)
title.buffer: fine-control of vertical position (annotate.page)
fignum: figure number (annotate.page)
title: vector of title lines (annotate.page)
ulh: vector for upper left headers (annotate.page)
urh: vector for upper right headers (annotate.page)
fnote: vector of 5 footnotes. 5th row is traditionally reserved for filepath, table reference and time stamp. Populate from bottom up. (annotate.page)
override: override
addTime: logical for ading time stamp (annotate.page)

Author

Greg Cicconetti