Skip to content
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
R
examples
inst
man
.Rbuildignore
.gitignore
DESCRIPTION
NAMESPACE
README.md
build.gradle

README.md

Brunel For Jupyter (R - IRkernel)

This project contains code for integrating Brunel into Jupyter using the IRkernel (for use with the R language).
rJava is used for the integration between R and Java for Brunel Visualization.

Pre-requisites

  • The IRkernel must be installed into Jupyter. This code will only work via a Jupyter notebook. It will not work in R desktop.
  • Java 1.7 or greater must be installed
  • The JAVA_HOME env variable must be set to the location of the Java installation
  • Install Brunel Visualization for Jupyter Notebooks: pip install brunel
  • On Win64, you may also need to modify your PATH to include jvm.dll. Try it first without doing this to see if it works. See this StackOverflow issue for more information.

Setup For Usage

Install:

Important: Install Brunel Visualization into R using R desktop, not from within IRkernel in Jupyter.

Installing Brunel for R requires the devtools library. First install devtools if you have not already and then install the brunel package. For example:

install.packages("devtools")
devtools::install_github("Brunel-Visualization/Brunel", subdir="R", ref="v2.3")

Samples

A sample notebook is included along with the required data in /examples. Below is an example of Brunel code as used within R:

 library(brunel)
 brunel ("x(mpg) y(horsepower)  mean(horsepower) color(origin) tooltip(name)", data=cars)

or

 brunel ("data('cars') x(mpg) y(horsepower)  mean(horsepower) color(origin) tooltip(name)")
You can’t perform that action at this time.