fpTxtGp: Get font settings for forestplot

View source: R/forestplot_helpers.R

fpTxtGpR Documentation

Get font settings for forestplot

Description

This function generates all the gpar() elements for the different text elements within the graph. Elements not specified inherit their default settings from the label argument.

Usage

fpTxtGp(label, summary, xlab, title, ticks, legend, legend.title, cex = 1)

Arguments

label

The text labels (see details below)

summary

The summary labels (see details below)

xlab

The xlab text

title

The plot title

ticks

The ticks associated with the xlab

legend

The legend text

legend.title

The legend title

cex

The font size

Value

A list of the fpTxtGp class

List arguments for label/summary

You can provide a list of elements for the label and summary in order to specify separate elements. If you provide a list in one dimension the gpar elements are assumed to follow the columns. If you provide a list of 2 dimensions the structure assumes is list[[row]][[column]] and the number of elements should correspond to the number of labels for the label argument, i.e. without the rows marked as summary elements. The same goes for summary arguments.

Examples

fpTxtGp(label = gpar(fontfamily = "HersheySerif"))

forestplot documentation built on Aug. 26, 2023, 5:07 p.m.