draw_study: Create a ggplot2 object with raw longitudinal data and...

Description Usage Arguments Value Author(s) References Examples

View source: R/draw_study.R

Description

Create a ggplot2 object with raw longitudinal data and optional model fits.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
draw_study(
  data_frame,
  fit = c("none", "linear", "spline", "piecewise", "poly")[1],
  facet = TRUE,
  group_name = maeve_options("group_name"),
  subject_ID = maeve_options("subject_ID"),
  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"),
  linear_color = maeve_options("linear_color"),
  spline_color = maeve_options("spline_color"),
  piecewise_color = maeve_options("piecewise_color"),
  poly_color = maeve_options("poly_color"),
  linear_lwd = maeve_options("linear_lwd"),
  spline_lwd = maeve_options("spline_lwd"),
  piecewise_lwd = maeve_options("piecewise_lwd"),
  poly_lwd = maeve_options("poly_lwd"),
  nrow_value = maeve_options("nrow_value"),
  ncol_value = maeve_options("ncol_value"),
  axis_text_x_size = maeve_options("axis_text_x_size"),
  axis_text_x_angle = maeve_options("axis_text_x_angle"),
  axis_text_x_hjust = maeve_options("axis_text_x_hjust"),
  axis_text_x_vjust = maeve_options("axis_text_x_vjust"),
  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"),
  geom_point_size = maeve_options("geom_point_size"),
  alpha_value = maeve_options("alpha_value")
)

Arguments

data_frame

data frame with factors for group and ID, numerics for time on study and response.

fit

character vector with names of fitted values to include.

facet

logical. Whether to facet plots by group. Defaults to TRUE.

group_name

character. See ?maeve_options().

subject_ID

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().

linear_color

character. See ?maeve_options().

spline_color

character. See ?maeve_options().

piecewise_color

character. See ?maeve_options().

poly_color

character. See ?maeve_options().

linear_lwd

character. See ?maeve_options().

spline_lwd

character. See ?maeve_options().

piecewise_lwd

character. See ?maeve_options().

poly_lwd

character. See ?maeve_options().

nrow_value

numeric. See ?maeve_options().

ncol_value

numeric. See ?maeve_options().

axis_text_x_size

numeric. See ?maeve_options().

axis_text_x_angle

numeric. See ?maeve_options().

axis_text_x_hjust

numeric. See ?maeve_options().

axis_text_x_vjust

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().

geom_point_size

numeric. See ?maeve_options().

alpha_value

numeric. See ?maeve_options().

Value

A ggplot2 object

Author(s)

Bill Forrest <forrest@gene.com>

Bill Forrest forrest@gene.com

References

www.r-project.org

Examples

1
2
3
4
5
6
7
8
9
 cat('Example for draw_study() in dontrun code block.')
 ## Not run: 
 data( vismodegib )
 vismo21 <- dplyr::filter( vismodegib, DAY_OF_STUDY <= 21 )
 pred_data_frame = vismo21 %>% model_study() %>% predict_study()
 figure_by_group <- draw_study( pred_data_frame, endpoint_name = 'y',
                                fit = 'spline', ncol_value = 5 )

## End(Not run)

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