R/auto_boxplot.R

In autostats: Auto Stats

#' auto_boxplot
#'
#' Wraps \code{\link[ggplot2]{geom_boxplot}} to simplify creating boxplots.
#'
#' @param .data data
#' @param continuous_outcome continuous y variable. unquoted column name
#' @param categorical_variable categorical x variable. unquoted column name
#' @param categorical_facets categorical facet variable. unquoted column name
#' @param alpha alpha points
#' @param width width of jitter
#' @param color_dots dot color
#' @param color_box box color
#'
#' @return ggplot
#' @export
#'
#' @examples
#'
#' iris %>%
#' auto_boxplot(continuous_outcome = Petal.Width, categorical_variable = Species)
auto_boxplot <- function(.data,
                         continuous_outcome,
                         categorical_variable,
                         categorical_facets = NULL,
                         alpha = .3,
                         width = .15,
                         color_dots = "black",
                         color_box = "red"){

    rlang::enexpr(categorical_facets) -> categorical_facets

  if(!is.null(categorical_facets)){
   .data %>%
      framecleaner::set_fct({{categorical_facets}}) -> .data
  }

  .data %>%
    framecleaner::set_fct({{categorical_variable}}) -> .data

  .data %>%
    ggplot2::ggplot(ggplot2::aes(x = {{categorical_variable}},
                        y = {{continuous_outcome}})) +
    ggplot2::geom_boxplot(color = color_box) +
    ggplot2::geom_jitter(alpha = alpha, width = width,  color = color_dots) +
    ggthemes::theme_clean() -> p1




  if(!is.null(categorical_facets)){
    p1 +
      ggplot2::facet_wrap(rlang::as_name(rlang::ensym(categorical_facets)))-> p1
  }

  p1
}