model_study: Fit longitudinal models to and return a list with models,...
In wfforrest/maeve: Modeling Accessories Enabling Visualization of Experiments

Description Usage Arguments Value Author(s) References Examples

Fit longitudinal models to and return a list with models, data frames, and miscellaneous.

model_study(
  study_data_frame,
  drop_truncated_levels = FALSE,
  return_all = FALSE,
  record_truncated_group_levels = TRUE,
  metric = maeve_options("metric"),
  weight_lmer_option = maeve_options("weight_lmer_option"),
  group_name = maeve_options("group_name"),
  subject_ID = maeve_options("subject_ID"),
  x_name = maeve_options("x_name"),
  endpoint_name = maeve_options("endpoint_name"),
  add_to_endpoint = maeve_options("add_to_endpoint"),
  trans_func_char = maeve_options("trans_func_char"),
  inv_func_char = maeve_options("inv_func_char"),
  test_func_x = maeve_options("test_func_x"),
  progress = maeve_options("progress"),
  abbreviate_n = maeve_options("abbreviate_n"),
  reference_Dunnett = maeve_options("reference_Dunnett"),
  restrict_x = maeve_options("restrict_x"),
  overall_x_min = maeve_options("overall_x_min"),
  overall_x_max = maeve_options("overall_x_max"),
  min_n_in_group = maeve_options("min_n_in_group"),
  min_frac_in_group = maeve_options("min_frac_in_group"),
  min_frac_in_study = maeve_options("min_frac_in_study"),
  number_basis_vecs = maeve_options("number_basis_vecs"),
  min_basis_vecs = maeve_options("min_basis_vecs"),
  max_basis_vecs = maeve_options("max_basis_vecs"),
  autoset_full_study_data = maeve_options("autoset_full_study_data"),
  autoset_modeling_data = maeve_options("autoset_modeling_data")
)

`study_data_frame`	a well-prepared data.frame with the study data and appropriate columns.
`drop_truncated_levels`	logical: whether to drop from factors levels that have been truncated away in the modeling data.
`return_all`	logical: return a whole bunch of output in a list.
`record_truncated_group_levels`	logical: whether to record level(s) of any groups that are entirely lost during data truncation in maeve_options("truncated_group_levels").
`metric`	character. See ?maeve_options().
`weight_lmer_option`	character. See ?maeve_options().
`group_name`	character. See ?maeve_options().
`subject_ID`	character. See ?maeve_options().
`x_name`	character. See ?maeve_options().
`endpoint_name`	character. See ?maeve_options().
`add_to_endpoint`	numeric. See ?maeve_options().
`trans_func_char`	character. See ?maeve_options().
`inv_func_char`	character. See ?maeve_options().
`test_func_x`	numeric. See ?maeve_options().
`progress`	logical. See ?maeve_options().
`abbreviate_n`	numeric. See ?maeve_options().
`reference_Dunnett`	character. See ?maeve_options().
`restrict_x`	logical. See ?maeve_options().
`overall_x_min`	numeric. See ?maeve_options().
`overall_x_max`	numeric. See ?maeve_options().
`min_n_in_group`	numeric. See ?maeve_options().
`min_frac_in_group`	numeric. See ?maeve_options().
`min_frac_in_study`	numeric. See ?maeve_options().
`number_basis_vecs`	numeric. See ?maeve_options().
`min_basis_vecs`	numeric. See ?maeve_options().
`max_basis_vecs`	numeric. See ?maeve_options().
`autoset_full_study_data`	logical. See ?maeve_options().
`autoset_modeling_data`	logical. See ?maeve_options().

An R list with named output.

Bill Forrest <forrest@gene.com>

Bill Forrest forrest@gene.com

www.r-project.org

 cat('Example for model_study() in dontrun code block.')
 ## Not run: 
 data( vismodegib )
 vismo21 <- dplyr::filter( vismodegib, DAY_OF_STUDY <= 21 )
 model_list <- model_study( vismo21 )

## End(Not run)