R/sankey_network.R

In cjyetman/network.r2d3: Makes interactive network graphs using r2d3

#' Create an interactive sankey network plot in a htmlwidget
#'
#' @param data a network description in one of numerous forms (see details)
#' @param width,height width and height of exported htmlwidget in pixels
#' (single integer value; default == NULL)
#' @param ... other options (see details)
#' @param viewer whether to view the plot in the internal viewer or browser
#'
#' @description
#' The `sankey_network` function creates an interactive sankey network plot in
#' a htmlwidget
#'
#' @md
#' @export

sankey_network <- function(data, width = NULL, height = NULL, ..., viewer = "internal") {
  data <- as_sankey_data(data, ...)

  data <- jsonlite::toJSON(data, null = "null", na = "null", auto_unbox = TRUE,
                           digits = getOption("shiny.json.digits", 16),
                           use_signif = TRUE, force = TRUE, POSIXt = "ISO8601",
                           UTC = TRUE, rownames = FALSE, keep_vec_names = TRUE,
                           json_verabitm = TRUE)

  options <- list(...)

  r2d3::r2d3(
    data = data,
    options = options,
    script = system.file("sankey_network.js", package = "network.r2d3"),
    dependencies = system.file("lib/d3-sankey/d3-sankey.min.js", package = "network.r2d3"),
    d3_version = 6,
    container = "div",
    width = width,
    height = height,
    viewer = viewer
  )
}