Default theme for the forest plot, but can pass other parameters. The parameters will be passed to corresponding elements of the forest plot.
ci_*
Control the graphical parameters of confidence intervals
legend_*
Control the graphical parameters of legend
xaxis_*
Control the graphical parameters of x-axis
refline_*
Control the graphical parameters of reference line
vertline_*
Control the graphical parameters of vertical line
summary_*
Control the graphical parameters of diamond shaped summary CI
footnote_*
Control the graphical parameters of footnote
title_*
Control the graphical parameters of title
arrow_*
Control the graphical parameters of arrow
See gpar
for more details.
forest_theme(
base_size = 12,
base_family = "",
ci_pch = 15,
ci_col = "black",
ci_alpha = 1,
ci_fill = NULL,
ci_lty = 1,
ci_lwd = 1,
ci_Theight = NULL,
legend_name = "Group",
legend_position = "right",
legend_value = "",
legend_gp = gpar(fontsize = base_size, fontfamily = base_family, cex = 1),
xaxis_gp = gpar(fontsize = base_size, fontfamily = base_family, lwd = 0.6, cex = 1),
refline_gp = gpar(lwd = 1, lty = "dashed", col = "grey20"),
vertline_lwd = 1,
vertline_lty = "dashed",
vertline_col = "grey20",
summary_col = "#4575b4",
summary_fill = summary_col,
footnote_gp = gpar(fontsize = base_size, fontfamily = base_family, cex = 0.6, fontface
= "plain", col = "black"),
footnote_parse = TRUE,
title_just = c("left", "right", "center"),
title_gp = gpar(cex = 1.2, fontface = "bold", col = "black", fontfamily = base_family),
arrow_type = c("open", "closed"),
arrow_label_just = c("start", "end"),
arrow_length = 0.05,
arrow_gp = gpar(fontsize = base_size, fontfamily = base_family, lwd = 0.6),
xlab_adjust = c("refline", "center"),
xlab_gp = gpar(fontsize = base_size, fontfamily = base_family, cex = 1, fontface =
"plain"),
...
)
A list.
The size of text
The font family
Shape of the point estimation. It will be reused if the forest plot is grouped.
Color of the CI. A vector of color should be provided for the grouped forest plot. An internal color set will be if only not.
Scalar value, alpha channel for transparency of point estimation. A small vertical line will be added to indicate the point estimation if this is not equals to 1.
Color fill the point estimation. A vector of color should be
provided for the grouped forest plot. If this is NULL
(default), the
value will inherit from "ci_col"
. This is valid only if
ci_pch
within 15:25.
Line type of the CI. A vector of line type should be provided for the grouped forest plot.
Line width of the CI. A vector of line type should be provided for the grouped forest plot.
A unit specifying the height of the T end of CI. If set to
NULL
(default), no T end will be drawn.
Title of the legend.
Position of the legend, "right"
, "top"
,
"bottom"
or "none"
to suppress the legend.
Legend labels (expressions). A vector should be provided for the grouped forest plot. A "Group 1" etc will be created if not a vector for a grouped forest plot.
gpar
graphical parameters of legend, see gpar
.
gpar
graphical parameters of x-axis, see gpar
.
gpar
graphical parameters of reference line, see gpar
.
Line width for extra vertical line. A vector can be provided for each vertical line, and the values will be recycled if no enough values are given.
Line type for extra vertical line. Works same as vertline_lwd
.
Line color for the extra vertical line. Works same as vertline_lwd
.
Color for borders of the summary diamond shape.
Color for filling the summary diamond shape.
gpar
graphical parameters of footnote, see gpar
.
Parse footnote text (default).
The justification of the title, default is 'left'
.
gpar
graphical parameters of title, see gpar
.
Type of the arrow below x-axis, see arrow
.
The justification of the arrow label relative to arrow. Control
the arrow label to align to the starting point of the arrow "start"
(default) or
the ending point of the arrow "end"
.
The length of the arrow head, default is 0.05
.
See arrow
.
gpar
graphical parameters of arrow, see gpar
.
Control the alignment of xlab to reference line (default) or center of the x-axis.
gpar
graphical parameters of xlab, see gpar
.
Other parameters passed to table. See tableGrob
for details.