figureBox: Background graphic function

In jbirstler/biostatrpts: Functions for UW-Biostatistics Report Creation

Description

A background function built into the graphing functions of biostatrpts that creates boxes around titles, p-values, and sample sizes in the margins of each figure

Usage

figureBox(
  boxPlot = TRUE,
  demoBarPlot = FALSE,
  pHoriz = pHoriz,
  pTitle = pTitle,
  titleCex = titleCex,
  printPVals = printPVals,
  pStrWrap = pStrWrap
)

Arguments

boxPlot	(logical) Is the figure a box plot (TRUE) or bar plot (FALSE)
demoBarPlot	(logical) If boxPlot=FALSE is the bar plot a demoBarPlot (TRUE) or regular bar plot (FALSE)
pHoriz	(uwBar)(logical)
pTitle	(string) Title of the figure
titleCex	(numeric) magnification factor for sizing the title
printPVals	(uwBar)(logical)
pStrWrap	(uwBarPlot)(logical)

Details

A background function built into the graphing functions of biostatrpts that creates boxes around titles, p-values, and sample sizes in the margins of each figure. It also returns values that are used for placement of text in the figure margins. A figure must be open to run this function as it calls for par('usr'), par('pin') and other graphing parameters.

Value

Returns a list of number of y-axis units per margin line and x-axis units per margin line

Author(s)

University of Wisconsin-Madison Biostatistics and Medical Informatics Department, Scott Hetzel M.S.

See Also

uwBoxPlot and uwBarPlot

jbirstler/biostatrpts documentation built on May 7, 2020, 12:10 a.m.