plot_all_arms: Plot all arms

View source: R/plotting_functs.R

plot_all_armsR Documentation

Plot all arms

Description

Plot all arms

Usage

plot_all_arms(
  summarized_results,
  parameter,
  metric,
  ylim = NULL,
  plot_discont_points = FALSE,
  arm_info = NULL,
  theoretical_values = NULL,
  ylab = NULL
)

Arguments

summarized_results

summarized results (as outputted by summarize_results) data frame in tibble form.

parameter

parameter to plot

metric

metric to plot

ylim

(optional) ylim

plot_discont_points

(default false) plot vertical lines showing the points where the threshold changes discontinuously? If TRUE, g_thresh must be present as a column in the summarized_results df.

arm_info

(optional) a list containing information about the arms; entries sohuld be "arm_names," "varying_param," and "all_params;" if empty, will be guessed from column names.

theoretical_values

(optional) theoretical values for each arm to plot as horizontal lines

ylab

(optional) y-axis label

Value

a cowplot containing the plotted arms


timothy-barry/glmeiv documentation built on Jan. 30, 2024, 3:46 p.m.