R/overallComponentsPlot.R

In amsantac/diffeR: Metrics of Difference for Comparing Pairs of Maps or Pairs of Variables

overallComponentsPlot <- function(comp = NULL, ref = NULL, ctmatrix = NULL, units = NULL, population = NULL,
                                  graphics_system = 'ggplot2'){
  
  ylab <- "Difference Size (percentage of domain)"
  
  if(!is.null(comp) & !is.null(ref)){
    resT <- differenceMR(comp, ref, eval = "original", population = population)[, c("Quantity", "Exchange", "Shift")]
  }
  
  if(!is.null(ctmatrix)){
    if(!is(ctmatrix, "matrix")) stop("ctmatrix must be of class matrix")
    if(!is.null(population)) ctmatrix <- sample2pop(ctmatrix, population)
    resT <- data.frame(Quantity = overallQtyD(ctmatrix), Exchange = overallExchangeD(ctmatrix), Shift = overallShiftD(ctmatrix))
    ylab <- ifelse(is.null(units), "Difference Size (units)", paste0("Difference Size (", units, ")"))
  }
  
  resT2 <- pivot_longer(resT, cols = everything(), names_to = "differenceType", values_to = "value")
  resT2$differenceType <- factor(resT2$differenceType, levels = c('Shift', 'Exchange', 'Quantity'))
  
  resT2$diff <- "diff"
  
  if(graphics_system == 'ggplot2'){
    
    ggplot(data = resT2, 
           aes(x = .data$diff, y = .data$value, fill = .data$differenceType)) + 
      geom_bar(stat = 'identity', col = 'black') + 
      labs(x = NULL, y = ylab, fill = '') + 
      theme_classic()+ 
      scale_y_continuous(expand = c(0, 0)) +
      scale_fill_manual(values = c(Shift = "#e6e6e6", Exchange = "#aeaeae", Quantity = "#4d4d4d")) +
      theme(axis.line.x = element_blank(),
            axis.ticks.x = element_blank(),
            axis.text.x = element_blank())
    
  } else if(graphics_system == 'graphics'){
    
    old.par <- par(no.readonly = TRUE)
    par(oma = c(0, 0, 0, 14))
    
    barplot(t(resT), ylab = ylab)
    
    par(fig = c(0, 1, 0, 1), oma = c(0, 0, 0, 0), mar = c(0, 0, 0, 0), new = TRUE)
    graphics::plot(0, 0, type = "n", bty = "n", xaxt = "n", yaxt = "n")
    legend(x = 0.1, y = 0.3, c(colnames(resT)[3:1]), bty = "n",
           fill = c("#e6e6e6", "#aeaeae", "#4d4d4d"))
    par(old.par)
  }
}