R/visNetwork.R

In netknitr: Knit Network Map for any Dataset

#' createVisNetwork
#'
#' @param nodes Nodes.
#' @param edges Edges.
#' @param background Background color.
#' @param border Border color.
#' @param highlight Highlight color.
#' @author Jayachandra N
#' @description
#' Generates network map using the nodes and edges objects generated by
#' getNodes and getEdges functions respectively.
#' @return Network map visualization
#' @import dplyr
#' @import visNetwork
#' @export
#' @examples
#' nodes <- getNodes(head(mtcars), c("cyl", "gear", "vs"), group = TRUE)
#' res <- fixNodeBias(head(mtcars))
#' edges <- getEdges(getAssociation(res), getNodes(res, group = TRUE))
#' createVisNetwork(nodes, edges)
createVisNetwork <- function(nodes, edges, background = "lightblue",
                             border = "darkblue", highlight = "yellow") {
  visNetwork::visNetwork(nodes, edges) %>%
    visNetwork::visNodes(color = list(background = "lightblue",
                                      border = "darkblue",
                                      highlight = "yellow"),
                         shadow = list(enabled = TRUE, size = 10))
}