forest_constructor: Forest Constructor
In metrumresearchgroup/pmforest: Create forest plots

View source: R/forest-constructor.R

forest_constructor

R Documentation

Forest Constructor

Description

Private helper to manipulate data and organize the structure of the forest plot and CI table

Usage

forest_constructor(
  data,
  args,
  nsim = NULL,
  summary_label = NULL,
  vline_intercept = 0,
  annotate_CI = TRUE,
  digits,
  maxex,
  shaded_interval = NULL,
  x_lab = "Effect",
  y_lab = NULL,
  plot_width,
  facet_titles = NULL,
  CI_label = NULL,
  CI_bracket_open,
  CI_bracket_close,
  table_layout = NULL,
  text_size = 3,
  x_limit = NULL,
  x_breaks = NULL,
  jitter_reps,
  shapes,
  shape_size,
  ggplot_theme
)

Arguments

`data`	a dataframe or tibble that contains the summarized data you want to plot. This must be in the same format as the tibble that is output by `summarize_data()`. See "Output Data" in Details section of `summarize_data()` documentation.
`args`	mean/median, low CI, upper CI relating to the selected reference column
`summary_label`	(optional) labeler function created using `ggplot2::as_labeller`. Labels for group and metagroup.
`vline_intercept`	(optional) numeric. Default 0.
`annotate_CI`	logical. Default `TRUE`. Show a table next to the graph with the numeric values for the confidence interval.
`digits`	numeric. Number of significant digits to round the table values to. Passed through to `pmtables::sig()`
`maxex`	numeric. Maximum number of significant digits before moving to scientific notation. Passed through to `pmtables::sig()`.
`shaded_interval`	numeric vector. Specified as c(lo, hi) for the interval you want to shade over. Default is NULL.
`x_lab`	string. x-axis label.
`y_lab`	string. Default is not to label y axis.
`plot_width`	numeric. Value between 1 and 12 to denote the ratio of plot : CI table
`CI_label`	string. Label above the CI table. Ignored if `annotate_CI` is `FALSE`.
`CI_bracket_open`	string. Denotes whether to use brackets (`[`) or parentheses (`(`) for the opening interval. Ignored if `annotate_CI` is `FALSE`.
`CI_bracket_close`	string. Denotes whether to use brackets (`⁠]⁠`) or parentheses (`⁠)⁠`) for the closing interval. Ignored if `annotate_CI` is `FALSE`.
`text_size`	numeric. Text size for labels. Must be at least 3.5
`x_limit`	numeric vector (c(lo, hi)) specifying the minimum and maximum values to show on the x-axis. See coord_cartesian() for details
`x_breaks`	numeric vector of breaks to be used for the x-axis. See scale_x_continuous() for details.
`jitter_reps`	logical. Whether or not to vertically "jitter" the additional confidence intervals when using multiple replicates (i.e. when input data has 9 numeric columns instead of 3).
`shapes`	string. Denotes the shape of the mean/median value, passed to `ggplot2::geom_point()`. Can be one of the following: "square", "diamond", "circle", or "triangle".
`shape_size`	numeric. Value between 1 and 4 that denotes the relative size of the `shape` argument. Defaults to 3.5.
`ggplot_theme`	a ggplot theme. Note that some legend options, text size, and grid elements may be overwritten. See `ggplot2::theme()` for details.