Learn R Programming

teal.modules.clinical (version 0.9.0)

template_g_ci: Template: Confidence Interval Plot

Description

Creates a valid expression to generate a ggplot2::ggplot() confidence interval plot.

Usage

template_g_ci(
  dataname,
  x_var,
  y_var,
  grp_var = NULL,
  stat = c("mean", "median"),
  conf_level = 0.95,
  unit_var = "AVALU",
  ggplot2_args = teal.widgets::ggplot2_args()
)

Value

a list of expressions to generate a table or plot object.

Arguments

dataname

(character)
analysis data used in teal module.

x_var

(character)
name of the treatment variable to put on the x-axis.

y_var

(character)
name of the response variable to put on the y-axis.

grp_var

(character)
name of the group variable used to determine the plot colors, point shapes, and line types.

stat

(character)
statistic to plot. Options are "mean" and "median".

conf_level

(numeric)
value for the confidence level within the range of (0, 1).

unit_var

(character)
name of the unit variable.

ggplot2_args

optional, (ggplot2_args)
object created by teal.widgets::ggplot2_args() with settings for the module plot. The argument is merged with option teal.ggplot2_args and with default module arguments (hard coded in the module body). For more details, see the vignette: vignette("custom-ggplot2-arguments", package = "teal.widgets").

See Also

tm_g_ci()