R/plot_indicators.R

In gmoroncorrea/VMSIndicators: VMS indicators

#' Plot efficiency indicators
#'
#' Make a plot of the nine efficiency indicators per period (YYYYMM).
#'
#' @param ind_data Dataset with efficiency indicators obtained from the
#' get_indicators function.
#' @param save_plot Logical value to indicate if plot is saved as PNG.
#' @param save_folder Folder to save the plot.
#' @return A PNG with the efficiency indicators plot.
#' @export
plot_indicators = function(ind_data, save_plot = FALSE, save_folder = './', ...) {

  plot_data = tidyr::gather(ind_data, key = 'indicator', value = 'valor', DIST:EFF_VIAJE)

  g2 = ggplot2::ggplot(data = plot_data, ggplot2::aes(x = TIME_IND, y = valor)) +
    ggplot2::geom_boxplot() +
    ggplot2::xlab('Periodo') +
    ggplot2::ylab('Valor') +
    ggplot2::theme_bw() +
    ggplot2::facet_wrap(ggplot2::vars(indicator), nrow = 3, scales = "free_y")

  if(save_plot) {
    ggplot2::ggsave(filename = file.path(save_folder, 'indicators_plot.png'), plot = g2, width = 180, height = 180, units = 'mm', dpi = 300, ...)
  }

  return(g2)

}