Prepares data set for a forest plot
Usage
forest_data(
panels,
panel.names = NULL,
col.key = "key",
col.estimate = "estimate",
col.stderr = "stderr",
col.lci = NULL,
col.uci = NULL,
col.left = NULL,
col.right = NULL,
col.keep = NULL,
row.labels = NULL,
row.labels.levels = NULL,
rows = NULL,
row.labels.space = c(0, 1, 0, 0),
ci.delim = ", ",
digits = 2,
exponentiate = TRUE,
scalepoints = FALSE,
minse = NULL,
addtext = NULL,
diamond = NULL,
col.diamond = NULL,
bold.labels = NULL
)Arguments
- panels
A list of data frames. These should include columns or point estimates, and standard errors or confidence interval limits. If you specify a row.labels data frame, then they must also all contain a key column with the same name (which can be specified by col.key).
- panel.names
A character vector. The names to be used for each forest plot panel. If none provided, then they will be numbered 1, 2, 3 ...
- col.key
Name of column that links the results given in each data frame provided in panels and the labels given in row.labels. If row.labels data frame is not given, then this column will be used as row labels. (Default: "key")
- col.estimate, col.stderr, col.lci, col.uci
Names of columns for: point estimates, standard errors, lower and upper limits of confidence intervals.
- col.left, col.right
Names of columns to be printed to the left/right of the plot.
- col.keep
Names of additional columns to be kept in returned data frame.
- row.labels
A data frame that contains the labels to be used for the rows of the plot. Use NA if a lower level heading is not required for a given row.
- row.labels.levels
A character vector. The names of columns in row.labels to use as headings/subheadings/labels for labelling rows.
- rows
If set, then only rows matching these labels (at the first level) will be included.
- row.labels.space
A numeric vector specifying the space after a row label heading, at the end of a row label heading 'section'. (Default: c(0, 1, 0, 0))
- ci.delim
Character string to separate lower and upper limits of confidence interval. (Default: ", ")
- digits
Number of digits after decimal point to show for estimates and confidence intervals. (Default: 2)
- exponentiate
Exponentiate estimates (and CIs) before plotting. (Default: TRUE)
- scalepoints
Should the points be scaled by inverse of the standard error? (Default: FALSE)
- minse
Minimum standard error to use when scaling point size. (Default will use minimum in the data.)
- addtext
A list of data frames. List must be the same length as panels. Data frames should contain a column with the name specified in col.key, and one or more of:
a column named 'text' containing character strings
columns named 'het_dof', 'het_stat', and 'het_p' containing character strings
columns names 'trend_stat' and 'trend_p' containing character strings
The character strings, heterogeneity test, and trend test results will be plotted in the column of estimates and CIs, below the row with the key given in the col.key column.
- diamond
Alternative to col.diamond. A character vectors identify the rows (using the key values) for which the estimate and CI should be plotted using a diamond.
- col.diamond
Plot estimates and CIs as diamonds. Name of a column of logical values.
- bold.labels
A character vector identifying row labels (using key values) which should additionally be bold. (Default: NULL)