classicforest: classic forest
In metrumresearchgroup/pmforest: Create forest plots

View source: R/classicforest.R

classicforest

R Documentation

classic forest

Description

Private helper to generate the forest plot. Called internally by forest_constructor

Usage

classicforest(
  plotdata,
  madata,
  nsim = NULL,
  group_level = NULL,
  summary_label = NULL,
  annotate_CI = FALSE,
  shaded_interval = NULL,
  facet_titles = NULL,
  vline_intercept = 0,
  col = "Blues",
  summary_col = "Blues",
  tick_col = "firebrick",
  text_size = 3,
  x_lab = "Effect",
  y_lab = NULL,
  x_limit = NULL,
  x_breaks = NULL,
  jitter_reps,
  shapes,
  shape_size,
  ggplot_theme
)

Arguments

`plotdata`	dataframe constructed by forest_constructor
`madata`	dataframe constructed by forest_constructor
`summary_label`	(optional) labeler function created using `ggplot2::as_labeller`. Labels for group and metagroup.
`annotate_CI`	logical. Default `TRUE`. Show a table next to the graph with the numeric values for the confidence interval.
`shaded_interval`	numeric vector. Specified as c(lo, hi) for the interval you want to shade over. Default is NULL.
`vline_intercept`	(optional) numeric. Default 0.
`text_size`	numeric. Text size for labels. Must be at least 3.5
`x_lab`	string. x-axis label.
`y_lab`	string. Default is not to label y axis.
`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.