rt_explore_plot_aggregate_2_numerics: returns a eih
In shane-kercheval/rtools: Package providing R tools and wrappers

rt_explore_plot_aggregate_2_numerics

R Documentation

returns a eih

Description

returns a eih

Usage

rt_explore_plot_aggregate_2_numerics(
  dataset,
  variable,
  comparison_variable,
  aggregation_function = NULL,
  aggregation_function_name = NULL,
  aggregation_count_minimum = 30,
  show_resampled_confidence_interval = FALSE,
  show_points = FALSE,
  show_labels = FALSE,
  x_zoom_min = NULL,
  x_zoom_max = NULL,
  y_zoom_min = NULL,
  y_zoom_max = NULL,
  log_scale_x = FALSE,
  log_scale_y = FALSE,
  base_size = 11
)

Arguments

`dataset`	dataframe
`variable`	a numeric variable (y-axis)
`comparison_variable`	the additional numeric variable (x-axis) that will be grouped
`aggregation_function`	the aggregation function that gives, for example, the mean of the 'variable' grouped by the 'comparison_variable' if no aggregation function is supplied the boxplots are showed for each grouped 'comparison_variable' value.
`aggregation_function_name`	the friendly name of the 'aggregation_function'
`aggregation_count_minimum`	the minimum number of samples to included for each 'comparison_variable' value. The default is 30, so any value of ‘comparison_variable' that didn’t occur at least 30 times would be removed. We need at least 30, otherwise when we bootstrap resample e.g. with a group that has 1 sample we'd pull e.g. 100 random samples of the same value
`show_resampled_confidence_interval`	when 'aggregation_function' is not null, then we have the option to show a confidence interval based on resampling
`show_points`	the show points
`show_labels`	show the labels
`x_zoom_min`	adjust (i.e. zoom in) to the x-axis; sets the minimum x-value for the adjustment
`x_zoom_max`	adjust (i.e. zoom in) to the x-axis; sets the maximum x-value for the adjustment
`y_zoom_min`	adjust (i.e. zoom in) to the y-axis; sets the minimum y-value for the adjustment
`y_zoom_max`	adjust (i.e. zoom in) to the y-axis; sets the maximum y-value for the adjustment
`log_scale_x`	if TRUE, applies scale_x_log10
`log_scale_y`	if TRUE, applies scale_y_log10
`base_size`	uses ggplot's base_size parameter for controling the size of the text