prFpGetLayoutVP: Get the main 'forestplot'

View source: R/private.R

prFpGetLayoutVPR Documentation

Get the main forestplot

Description

The layout makes space for a legend if needed

Usage

prFpGetLayoutVP(lineheight, labels, legend_layout = NULL)

Arguments

lineheight

Height of the graph. By default this is auto and adjusts to the space that is left after adjusting for x-axis size and legend. Sometimes it might be desirable to set the line height to a certain height, for instance if you have several forestplots you may want to standardize their line height, then you set this variable to a certain height, note this should be provided as a unit object. A good option is to set the line height to unit(2, "cm"). A third option is to set line height to "lines" and then you get 50% more than what the text height is as your line height

labels

The labels

legend_layout

A legend layout object if applicable

Value

viewport Returns the viewport needed


gforge/forestplot documentation built on Aug. 30, 2023, 7:40 a.m.