R/plot_mpower.R

In metapower: Power Analysis for Meta-Analysis

#' Plot Power Curve for Meta-analysis
#'
#' Plots power curves for fixed effects models with various effect size magnitudes. Also plots power curves for various levels
#' of heterogeneity (e.g., i2 = 75%)
#'
#' @export
#'
#' @param obj This should be an "mpower" object
#'
#' @return Power curve plot for the user specified input parameters

plot_mpower <- function(obj){

  if(class(obj) != "mpower")
    stop("Object must be of class: mpower")

  ## set aesthetic
  p_aes <- list(geom_hline(yintercept = .80, linetype = "dashed", alpha = .80),
                geom_line(size = 1.5),
                scale_x_continuous(limits = c(2,max(obj$power_range$k_v)), breaks = c(seq(2,max(obj$power_range$k_v),by = round(max(obj$power_range$k_v)*.10,0)))),
                scale_y_continuous(limits =c(0,1), breaks = c(0,.20,.40,.60,.80,1)),
                xlab("Number of Studies"),
                ylab("Power"),
                theme_bw(),
                theme(legend.position = c(1,0),
                      legend.justification = c(1,0),
                      legend.background = element_rect(colour = 'black', fill = 'white', linetype='solid')))

  return(ggplot(obj$power_range %>% tidyr::pivot_longer(c("fixed_power", "random_power"), names_to = "power_type", values_to = "power"),
                aes(x = .data$k_v, y = .data$power, color = .data$power_type)) + p_aes +
           geom_point(aes(x = obj$k, y = obj$power$fixed_power),shape = 21, size = 3, fill = "white", color = "#993366", stroke = 1) +
           geom_point(aes(x = obj$k, y = obj$power$random_power),shape = 21, size = 3, fill = "white",color = "#33CCCC", stroke = 1) +
           ggtitle("Power Analysis for Summary Effect Size") +
           scale_color_manual(name = "Model",
                              labels = c("Fixed Effects", paste0("Random Effects (I2 = ",round(obj$i2*100,2), "%)")),
                              values = c("#993366", "#33CCCC")))

}