rt_explore_plot_boxplot: returns a boxplot of 'variable', potentally grouped by...

View source: R/explore_basics.R

rt_explore_plot_boxplotR Documentation

returns a boxplot of 'variable', potentally grouped by 'comparison_variable'

Description

returns a boxplot of 'variable', potentally grouped by 'comparison_variable'

Usage

rt_explore_plot_boxplot(
  dataset,
  variable,
  comparison_variable = NULL,
  color_variable = NULL,
  facet_variable = NULL,
  simple_mode = FALSE,
  y_zoom_min = NULL,
  y_zoom_max = NULL,
  log_scale_y = FALSE,
  base_size = 11
)

Arguments

dataset

dataframe containing numberic columns

variable

the variable from which to create a boxplot

comparison_variable

the additional variable to group by; must be a string/factor column

color_variable

if comparison_variable is used, then if color_variable is used the boxplots will be colored by this variable rather than each of the comparison_variable categories. 'color_variable' must be categoric

facet_variable

if comparison_variable is used, then if facet_variable is used the boxplots will be faceted by this variable 'faceted' must be categoric

simple_mode

if a comparison variable is used (and no color variable), use a single color

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_y

if TRUE, applies scale_y_log10

base_size

uses ggplot's base_size parameter for controling the size of the text


shane-kercheval/rtools documentation built on July 7, 2022, 8:31 a.m.