draw_overlay: Create a ggplot2 object with model overlay fits from a maeve...

In wfforrest/maeve: Modeling Accessories Enabling Visualization of Experiments

Description

Create a ggplot2 object with model overlay fits from a maeve study.

Usage

draw_overlay(
  data_frame,
  fit = c("spline", "linear", "piecewise", "poly", "none"),
  group_name = maeve_options("group_name"),
  x_name = maeve_options("x_name"),
  endpoint_name = maeve_options("endpoint_name"),
  linear_predictor = maeve_options("linear_predictor"),
  spline_predictor = maeve_options("spline_predictor"),
  piecewise_predictor = maeve_options("piecewise_predictor"),
  poly_predictor = maeve_options("poly_predictor"),
  axis_text_x_size = maeve_options("axis_text_x_size"),
  axis_text_x_angle = maeve_options("axis_text_x_angle"),
  axis_text_y_size = maeve_options("axis_text_y_size"),
  strip_text_size = maeve_options("strip_text_size"),
  legend_text_size = maeve_options("legend_text_size"),
  legend_position_char = maeve_options("legend_position_char"),
  title_label = maeve_options("title_label"),
  x_label = maeve_options("x_label"),
  y_label = maeve_options("y_label"),
  geom_na_rm = maeve_options("geom_na_rm")
)

Arguments

data_frame	data frame with a factor for group, numerics for time on study and response, and fitted numeric response curves.
fit	character vector with names of fitted values to include.
group_name	character. See ?maeve_options().
x_name	character. See ?maeve_options().
endpoint_name	character. See ?maeve_options().
linear_predictor	character. See ?maeve_options().
spline_predictor	character. See ?maeve_options().
piecewise_predictor	character. See ?maeve_options().
poly_predictor	character. See ?maeve_options().
axis_text_x_size	numeric. See ?maeve_options().
axis_text_x_angle	numeric. See ?maeve_options().
axis_text_y_size	numeric. See ?maeve_options().
strip_text_size	numeric. See ?maeve_options().
legend_text_size	numeric. See ?maeve_options().
legend_position_char	character. See ?maeve_options().
title_label	character. See ?maeve_options().
x_label	character. See ?maeve_options().
y_label	character. See ?maeve_options().
geom_na_rm	logical. See ?maeve_options().

Value

A ggplot2 object

Author(s)

Bill Forrest <[e-mail]>

Bill Forrest [e-mail]

References

www.r-project.org

Examples

 cat("Currently no running example for draw_overlay(). See next block.")
 ## Not run: 
 data( vismodegib )
 vismo21 <- dplyr::filter( vismodegib, DAY_OF_STUDY <= 21 )
 pred_data_frame = vismo21 %>% model_study() %>% predict_study()
 figure_overlay <- draw_overlay( pred_data_frame )

## End(Not run)

wfforrest/maeve documentation built on Jan. 1, 2021, 12:47 p.m.