fpColors: A function for the color elements used in the forestplot2()

In raredd/Gmisc0: Collection of functions for plotting relations, generating tables, and more.

Description

This function encapsulates all the colors that are used in the forestplot2 function. As there are plenty of color options this function gathers them all in one place.

Usage

fpColors(all.elements, box = "black", lines = "gray", summary = "black",
  zero = "lightgray", text = "black", axes = "black")

Arguments

all.elements	A color for all the elements. If set to NULL then it's set to the par("fg") color
box	The color of the box indicating the estimate
lines	The color of the confidence lines
summary	The color of the summary
zero	The color of the zero line
text	The color of the text
axes	The color of the x-axis at the bottom

Details

If you have several values per row in a forestplot you can set a color to a vector where the first value represents the first line/box, second the second line/box etc. The vectors are only valid for the box & lines options.

This function is a copy of the meta.colors function in the rmeta package.

Value

list A list with the elements:

box	the color of the box/marker
lines	the color of the lines
summary	the color of the summary
zero	the color of the zero vertical line
text	the color of the text
axes	the color of the axes

Author(s)

Max Gordon, Thomas Lumley

See Also

Other forestplot functions: forestplot2; fpDrawCircleCI, fpDrawDiamondCI, fpDrawNormalCI, fpDrawPointCI, fpDrawSummaryCI

raredd/Gmisc0 documentation built on May 27, 2019, 2:02 a.m.