Circle plot with bundled edges
R JavaScript CSS
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
R
docs
inst
man
vignettes
.Rbuildignore
.gitignore
.travis.yml
DESCRIPTION
NAMESPACE
README.md
_pkgdown.yml
edgebundleR.Rproj

README.md

Circle plot with bundled edges

Travis-CI Build Status CRAN_Status_Badge

This package allows R users to easily create a hierarchical edge bundle plot. The underlying D3 code was adapted from Mike Bostock's examples (see here or here) and the package is based on the htmlwidgets framework.

Many thanks to timelyportfolio for some major improvements.

Installation

You can install edgebundleR from Github using the devtools package as follows:

# install.packages("devtools")
devtools::install_github("garthtarr/edgebundleR")

Or you can get it on CRAN:

install.packages("edgebundleR")

Usage

library(edgebundleR)

The main function in the edgebundleR package is edgebundle(). It takes in a variety of inputs:

  • an igraph object
  • a symmetric matrix, e.g. a correlation matrix or (regularised) precision matrix
  • a JSON file structured with name and imports as the keys

The result of the edgebundle() function is a webpage that is rendered in the RStudio Viewer pane by default, but also may be exported to a self contained webpage, embedded in an Rmarkdown document or used in a Shiny web application.