R/timeline_specs.R

In 2DegreesInvesting/r2dii.plot.static: Create Standard Static '2dii' Plots

#' Creates the default specs data frame for [plot_timelineA()]
#'
#' @inheritParams plot_timelineA
#'
#' @seealso plot_timelineA
#' @return A data frame useful as the `specs` argument of [plot_timelineA()].
#' @export
#' @examples
#' data <- prepare_for_timelineB(sda_target)
#' timeline_specs(data)
timeline_specs <- function(data) {
  check_crucial_names(data, "line_name")

  to_title <- function(x) {
    paste(tools::toTitleCase(unlist(strsplit(x, "_"))), collapse = " ")
  }

  line_names <- unique(data$line_name)
  labels <- unlist(lapply(line_names, to_title))
  tibble(line_name = line_names, label = labels) %>%
    stop_if_too_many_lines() %>%
    add_r2dii_colours()
}

stop_if_too_many_lines <- function(data) {
  n_lines <- nrow(data)
  n_colours <- nrow(r2dii_palette_colours())
  if (n_lines > n_colours) {
    abort(glue(
        "Can't plot more than {n_colours} lines. Found {n_lines} lines:
        {toString(data$line_name)}."
    ))
  }

  invisible(data)
}

add_r2dii_colours <- function(specs) {
  n <- seq_len(nrow(specs))
  specs$r2dii_colour_name <- r2dii_palette_colours()$label[n]

  specs %>%
    left_join(r2dii_palette_colours(), by = c("r2dii_colour_name" = "label")) %>%
    select(-.data$r2dii_colour_name)
}