R/apply_graph_theme.R

In psyverse: Decentralized Unequivocality in Psychological Science

#' Apply multiple DiagrammeR global graph attributes
#'
#' @param dctGraph The [DiagrammeR::DiagrammeR] graph to apply the attributes to.
#' @param ... One or more character vectors of length three, where the first element is
#' the attribute, the second the value, and the third, the attribute type (`graph`,
#' `node`, or `edge`).
#'
#' @return The [DiagrammeR::DiagrammeR] graph.
#' @examples
#' exampleSpec <-
#'   system.file("inst",
#'               "extdata",
#'               "example_dct_spec_1.dct",
#'               package="psyverse");
#' parsedSpecs <- load_dct_specs(exampleSpec);
#' dctGraph <- parsedSpecs$output$basic_graph;
#' dctGraph <- apply_graph_theme(dctGraph,
#'                               c("color", "#0000AA", "node"),
#'                               c("fillcolor", "#00FFFF", "node"));
#' @export
apply_graph_theme <- function(dctGraph,
                              ...) {

  if (!requireNamespace("DiagrammeR", quietly = TRUE)) {
    stop("This function applies graph themes to a `DiagrammeR` object. ",
         "Therefore, obviously, that object must first exist, and you need ",
         "the `DiagrammeR` package to create it and work with it. Please ",
         "install it using:\n\n  install.packages('DiagrammeR');\n",
         call. = FALSE)
  }

  for (currentSetting in list(...)) {
    if ((length(currentSetting) != 3) && is.character(currentSetting)) {
      stop("Only provide character vectors of length 3 in the dots (...) argument!");
    } else {
      dctGraph <-
        DiagrammeR::add_global_graph_attrs(dctGraph,
                                           currentSetting[1],
                                           currentSetting[2],
                                           currentSetting[3]);
    }
  }
  return(dctGraph);
}