R/plots_for_performance_metrics.R

In uriahf/rtichoke: rtichoke

#' Create ggplot for Performance Metrics
#'
#' Makes a ggplot for the metrices
#'
#' @param performance_data an rtichoke Performance Data
#' @param x_perf_metric a performance metrice for the x axis
#' @param y_perf_metric a performance metrice for the y axis
#' @param color_values color palette
#'
#' @keywords internal
create_ggplot_for_performance_metrics <- function(performance_data,
                                                  x_perf_metric,
                                                  y_perf_metric,
                                                  color_values = c(
                                                    "#5BC0BE",
                                                    "#FC8D62",
                                                    "#8DA0CB",
                                                    "#E78AC3",
                                                    "#A4243B"
                                                  )) {
  if (!(names(performance_data)[1] %in% c("population", "model"))) {
    color_values_vec <- "black"


    ggplot_for_performance_metrics <- ggplot2::ggplot() +
      ggplot2::geom_point(
        data = performance_data,
        ggplot2::aes_string(
          x = x_perf_metric,
          y = y_perf_metric
        ), size = 1
      ) +
      ggplot2::geom_path(
        data = performance_data,
        ggplot2::aes_string(
          x = x_perf_metric,
          y = y_perf_metric
        ), size = 1
      )
  } else {
    color_values_vec <- color_values[
      seq_len(length(unique(performance_data %>%
        dplyr::pull(1))))
    ]

    if (length(unique(performance_data %>% dplyr::pull(1))) == 1) {
      color_values_vec <- "black"
    }

    if (length(unique(performance_data %>% dplyr::pull(1))) > 1) {
      names(color_values_vec) <- unique(performance_data %>% dplyr::pull(1))
    }

    ggplot_for_performance_metrics <- ggplot2::ggplot() +
      ggplot2::geom_point(
        data = performance_data,
        ggplot2::aes_string(
          x = x_perf_metric,
          y = y_perf_metric,
          group = names(performance_data)[1],
          color = names(performance_data)[1]
        ), size = 1
      ) +
      ggplot2::geom_path(
        data = performance_data,
        ggplot2::aes_string(
          x = x_perf_metric,
          y = y_perf_metric,
          group = names(performance_data)[1],
          color = names(performance_data)[1]
        ), size = 1
      )
  }

  ggplot_for_performance_metrics +
    ggplot2::theme_classic() +
    ggplot2::theme(legend.position = "none") +
    ggplot2::scale_color_manual(values = color_values_vec)
}


#' remove_grid_lines_from_plotly
#'
#' @param plotly_object a plotly plot for performance metrics
#' @keywords internal
remove_grid_lines_from_plotly <- function(plotly_object) {
  plotly_object %>%
    plotly::layout(
      xaxis = list(showgrid = FALSE),
      yaxis = list(showgrid = FALSE)
    )
}