R/overplot_horizontal_lines.R

In daviddoret/GRCRToolkit: GRC Toolkit

require(ggplot2)

#' overplot_vertical_lines
#'
#' Enriches a graph with good looking vertical lines.
#' For instance, this may be used to represend point estimates and limits in a PDF.
#'
#' @param graph a ggplot graph, typically a PDF or CDF
#'
#' @param estim_quantiles a vector of estimated quantiles (aka x values)
#'
#' @param estim_labels meaningful labels to describe the estimated quantiles
#'
#' @return an good looking graph enriched with visual representations for the estimates
#'
#' @examples
#' fun <- function(x, ...) { return(dlnorm(x = x, meanlog = 100, sdlog = 20, log = FALSE))  }
#' graph <- plot_probability_density_function(fun = fun, x_start = 10, x_end = 150)
#' graph_enriched <- overplot_horizontal_lines(graph=graph, x_values = c(.05,.95), x_labels = c("a","b"))
#' graph_enriched
#'
overplot_horizontal_lines <- function(
  y_values,
  y_labels = NULL,
  color = NULL,
  alpha = NULL,
  plot_addition = NULL,
  verbosity = NULL,
  ...) {

  if (is_void(color)) { color = "red" }
  if (is_void(alpha)) { alpha = .75 }
  if (is_void(verbosity)) { verbosity <- 0 }

  plot_01 <-
    # Enrich the plot with the vertical bars
    geom_hline(
      yintercept = y_values,
      color = color,
      linetype = "solid",
      show_guide = TRUE,
      alpha = alpha,
      size = 1.05) + #model_config_get_option("plot", "estimates", "xintercept", "size")) +

  if (!is_void(y_labels)) {
    plot_01 <- plot_01 +
      # Enrich the plot with the vertical bar labels
      annotate(
        color = "darkgrey",
        geom = "text",
        y = y_values,
        x = 0,
        label = y_labels,
        angle = 90,
        hjust = .5,
        vjust = 0,
        size = 6)
  }

  if (!is_void(plot_addition)) {
    plot_01 <- plot_01 + plot_addition
  }

  return(plot_01)

  }