edit_plot

This function is used to edit the graphical parameter of text and background
of the forest plot.

Create a forest plot based on the layout of the data. Confidence intervals in multiple columns by groups can be done easily. Editing the plot, inserting/adding text, applying a theme to the plot, and much more.

Alim Dayim

forestploter

Create a Flexible Forest Plot

Alimu Dayimu

edit_plot function

<dl><dt>plot</dt>
<dd>A forest plot object.</dd>
<dt>row</dt>
<dd>A numeric value or vector indicating row number to edit in the
dataset. Will edit the whole row if left blank for the body. This will be
ignored if the <code>part</code> is "header".</dd>
<dt>col</dt>
<dd>A numeric value or vector indicating column to edit in the dataset.
Will edit the whole column if left blank.</dd>
<dt>part</dt>
<dd>Part to edit, <code>"body"</code> (default) or <code>"header"</code>.</dd>
<dt>which</dt>
<dd>Which element to edit, <code>"text"</code>, <code>"background"</code> or
<code>"ci"</code> (confidence interval). This will not edit diamond shaped summary
CI, please change it with <code>forest_theme</code>. Also, change in <code>ci</code> will
not have any impact on the legend.</dd>
<dt>gp</dt>
<dd>Pass <code>gpar</code> parameters, see <code><a href="/link/gpar?package=forestploter&version=1.1.2" data-mini-rdoc="forestploter::gpar">gpar</a></code>. It should
be passed as <code>gpar(col = "red")</code>. For <code>which = "ci"</code>, please refer to
<code>forest_theme</code> <code>ci_*</code> parameters for the editable elements.</dd>
<dt>...</dt>
<dd>Other parameters to be passed to the grobs. For the <code>"text"</code>, please
see <code><a href="/link/textGrob?package=forestploter&version=1.1.2" data-mini-rdoc="forestploter::textGrob">textGrob</a></code> for details and <code><a href="/link/rectGrob?package=forestploter&version=1.1.2" data-mini-rdoc="forestploter::rectGrob">rectGrob</a></code>
for <code>"background"</code>. This will be ignored if <code>which = "ci"</code> as changing
parameters for the confidence interval are not allowed except for the graphical
parameters.</dd></dl>

Arguments

Edit forest plot — edit_plot

<dl>

<dt>plot</dt>
<dd>A forest plot object.</dd>


<dt>row</dt>
<dd>A numeric value or vector indicating row number to edit in the
dataset. Will edit the whole row if left blank for the body. This will be
ignored if the <code>part</code> is "header".</dd>


<dt>col</dt>
<dd>A numeric value or vector indicating column to edit in the dataset.
Will edit the whole column if left blank.</dd>


<dt>part</dt>
<dd>Part to edit, <code>"body"</code> (default) or <code>"header"</code>.</dd>


<dt>which</dt>
<dd>Which element to edit, <code>"text"</code>, <code>"background"</code> or
<code>"ci"</code> (confidence interval). This will not edit diamond shaped summary
CI, please change it with <code>forest_theme</code>. Also, change in <code>ci</code> will
not have any impact on the legend.</dd>


<dt>gp</dt>
<dd>Pass <code>gpar</code> parameters, see <code><a href='https://rdrr.io/r/grid/gpar.html'>gpar</a></code>. It should
be passed as <code>gpar(col = "red")</code>. For <code>which = "ci"</code>, please refer to
<code>forest_theme</code> <code>ci_*</code> parameters for the editable elements.</dd>


<dt>...</dt>
<dd>Other parameters to be passed to the grobs. For the <code>"text"</code>, please
see <code><a href='https://rdrr.io/r/grid/grid.text.html'>textGrob</a></code> for details and <code><a href='https://rdrr.io/r/grid/grid.rect.html'>rectGrob</a></code>
for <code>"background"</code>. This will be ignored if <code>which = "ci"</code> as changing
parameters for the confidence interval are not allowed except for the graphical
parameters.</dd>

</dl>

edit_plot: Edit forest plot

Description

Usage

Value

Arguments

See Also