R/plot_summary.r

Defines functions plot_summary

Documented in plot_summary

#' Create box plots for given analytical choices
#'
#' @description `r lifecycle::badge("deprecated")`
#'    This function is deprecated because the new version of specr uses a new analytic framework.
#'    In this framework, you can plot a similar figure simply by using the generic \code{plot()} function and adding the argument \code{type = "boxplot"}.
#'    This function provides a convenient way to visually investigate the effect of individual choices on the estimate of interest. It produces box-and-whisker plot(s) for each provided analytical choice.
#'
#' @param df a data frame resulting from \code{run_specs()}.
#' @param choices a vector specifying which analytical choices should be plotted. By default, all choices are plotted.
#'
#' @return a \link[ggplot2]{ggplot} object.
#'
#' @export
#'
#' @examples
#' # run spec analysis
#' results <- run_specs(example_data,
#'                      y = c("y1", "y2"),
#'                      x = c("x1", "x2"),
#'                      model = "lm",
#'                      controls = c("c1", "c2"),
#'                      subset = list(group1 = unique(example_data$group1)))
#'
#' # plot boxplot comparing specific choices
#' plot_summary(results, choices = c("subsets", "controls", "y"))
#' @seealso [summarise_specs()] to investigate the affect of analytical choices in more detail.
plot_summary <- function(df,
                         choices = c("x", "y", "model", "controls", "subsets")) {

  # Deprecation warning
  lifecycle::deprecate_warn("1.0.0", "plot_summary()", "plot.specr.object()")

  value <- key <- NULL

  df %>%
    dplyr::mutate(controls = ifelse(grepl("[+]", .data$controls), "all covariates", .data$controls)) %>%
    tidyr::gather(key, value, choices) %>%
    ggplot(aes(x = .data$value, y = .data$estimate, fill = .data$key)) +
      geom_boxplot(outlier.color = "red") +
      coord_flip() +
      scale_fill_brewer(palette = "Blues") +
      facet_grid(.data$key~1, scales = "free_y", space = "free") +
      theme_minimal() +
      theme(legend.position = "none",
            axis.line = element_line("black", size = .5),
            axis.text = element_text(colour = "black"),
            strip.text.x = element_blank()) +
    labs(x = "")
}
masurp/specr documentation built on March 17, 2024, 5:23 p.m.