R/plot_experiments_matrix.R

In pabloOnate/iraceplot: Plots for visualizing the data produced by the irace package

#' Heat Map Plot
#'
#' @description
#' The `plot_experiments_matrix` function creates a plot that shows all experimental 
#' data configurations in a heat map fashion. Configurations are shown in the x 
#' axis in the order in which are created in the configuration process. Instances 
#' are shown in the y axis in the order in which where executed in the configuration 
#' process. The colors show the overall rank (across the all performance data) of the 
#' performance evaluation displayed.
#' 
#' This plot gives a general idea of the configuration process progression, the
#' number of evaluations of each configuration show how long they survived in the 
#' iterated racing procedure.
#'
#' @template arg_irace_results
#'
#' @param file_name
#' string, File name to save plot (example: "~/patch/example/file_name.png")
#'
#' @param .interactive
#' Logical (Default interactive()), TRUE if the plot is generated interactively 
#' (plotly package), or FALSE it should be generated statically.
#'
#' @return heatmap plot
#' @export
#'
#' @examples
#' plot_experiments_matrix(iraceResults)
plot_experiments_matrix <- function(irace_results, file_name = NULL, .interactive = interactive()) {
  # Variable assignment
  C <- RANK <- text <- i_id <- union <- NULL

  # The values of the experiments are assigned to the variable experiments
  experiments <- irace_results$experiments
  experiments[] <- rank(experiments, na.last = "keep")

  # he table is created and organized for ease of use
  tabla <- experiments %>%
    as.data.frame() %>%
    rownames_to_column("i_id") %>%
    pivot_longer(-c(i_id), names_to = "C", values_to = "RANK") %>%
    mutate(C = fct_relevel(C, as.character(1:ncol(experiments)))) %>%
    mutate(i_id = fct_relevel(i_id, as.character(1:nrow(experiments))))

  # The text field was added to the table to show it in the interactive plot
  tabla <- tabla %>%
    mutate(text = paste0("x: ", C, "\n", "y: ", i_id, "\n", "Value: ", round(RANK, 2), "\n"))

  # Heat map plot is created
  p <- ggplot(tabla, aes(x = C, y = i_id, fill = RANK, text = text)) +
    geom_tile() +
    scale_fill_viridis_c(na.value = "#ECE1EB") +
    labs(x = "Configurations", y = "Instances") +
    theme(axis.text.x = element_blank(), axis.ticks = element_blank())

  # The plot becomes interactive
  if (.interactive) {
    p <- plotly::ggplotly(p, tooltip = "text")
  }


  # If the value in file_name is added the pdf file is created
  if (!is.null(file_name)) {
    # The file_name value is worked to separate it and assign it to new values.
    nameFile <- basename(file_name)
    directory <- paste0(dirname(file_name), sep = "/")
    withr::with_dir(directory, orca(p, paste0(nameFile, ".pdf")))

    # If you do not add the value of file_name, the plot is displayed
  } else {
    p
    return(p)
  }
}