prFpGetLegendBoxPosition

Used for the forestplot legend box.

internal

Allows the creation of forest plots with advanced features, such as
multiple confidence intervals per row, customizable fonts for individual text
elements, and flexible confidence interval drawing. It also supports mixing
text with mathematical expressions. The package extends the application of
forest plots beyond traditional meta-analyses, offering a more general version
of the original 'rmeta' package’s forestplot() function. It relies heavily on
the 'grid' package for rendering the plots.

Max Gordon

forestplot

Advanced Forest Plot Using 'grid' Graphics

Thomas Lumley

prFpGetLegendBoxPosition function

<dl><dt>pos</dt>
<dd>The position of the legend, either at the "top" or the "right" unless
positioned inside the plot. If you want the legend to be positioned inside the plot
then you have to provide a list with the same x &amp; y qualities as <code><a href="/link/legend?package=forestplot&version=3.1.5" data-mini-rdoc="forestplot::legend">legend</a></code>.
For instance if you want the legend to be positioned at the top right corner then
use <code>pos = list("topright")</code> - this is equivalent to <code>pos = list(x = 1, y = 1)</code>.
If you want to have a distance from the edge of the graph then add a inset to the list,
e.g. <code>pos = list("topright", "inset" = .1)</code> - the inset should be either a <code><a href="/link/unit?package=forestplot&version=3.1.5" data-mini-rdoc="forestplot::unit">unit</a></code>
element or a value between 0 and 1. The default is to have the boxes aligned vertical, if
you want them to be in a line then you can specify the "align" option, e.g.
<code>pos = list("topright", "inset" = .1, "align" = "horizontal")</code></dd></dl>

Arguments

Converts legend position to a standard position — prFpGetLegendBoxPosition

<dl>

<dt>pos</dt>
<dd>The position of the legend, either at the "top" or the "right" unless
positioned inside the plot. If you want the legend to be positioned inside the plot
then you have to provide a list with the same x &amp; y qualities as <code><a href='https://rdrr.io/r/graphics/legend.html'>legend</a></code>.
For instance if you want the legend to be positioned at the top right corner then
use <code>pos = list("topright")</code> - this is equivalent to <code>pos = list(x = 1, y = 1)</code>.
If you want to have a distance from the edge of the graph then add a inset to the list,
e.g. <code>pos = list("topright", "inset" = .1)</code> - the inset should be either a <code><a href='https://rdrr.io/r/grid/unit.html'>unit</a></code>
element or a value between 0 and 1. The default is to have the boxes aligned vertical, if
you want them to be in a line then you can specify the "align" option, e.g.
<code>pos = list("topright", "inset" = .1, "align" = "horizontal")</code></dd>

</dl>

prFpGetLegendBoxPosition: Converts legend position to a standard position

Description

Usage

Value

Arguments