gg4clj is a lightweight wrapper to make it easy to use R's ggplot2 library from Clojure. It provides a straightforward way to express R code as Clojure data, including easy mapping between Clojure data and R's data.frame, and some plumbing to send this code to R and recover the rendered graphics. It also provides a Gorilla REPL renderer plugin to allow rendered plots to be displayed inline in Gorilla worksheets. It is not a Clojure rewrite of ggplot2 - it calls R, which must be installed on your system (see below), to render the plots. You'll need to be familiar with R and ggplot2, or else the commands will seem fairly cryptic.
An example, generating some random numbers in Clojure, and then plotting a 2D-density in ggplot:
(defn b-m
[]
(let [a (rand)
b (rand)
r (Math/sqrt (* -2 (Math/log a)))
th (* 2 Math/PI b)]
(* r (Math/cos th))))
(def g-dat {:g1 (repeatedly 50 b-m) :g2 (repeatedly 50 b-m)})
(gg4clj/view [[:<- :g (gg4clj/data-frame g-dat)]
(gg4clj/r+
[:ggplot :g [:aes :g1 :g2]]
[:xlim -2 2]
[:ylim -2 2]
[:geom_point {:colour "steelblue" :size 4}]
[:stat_density2d {:colour "#FF29D2"}]
[:theme_bw])]
{:width 5 :height 5})
See more examples in the ws/demo.clj worksheet, which you can view here:
http://viewer.gorilla-repl.org/view.html?source=github&user=JonyEpsilon&repo=gg4clj&path=ws/demo.clj
To use gg4clj in your project add it as a dependency to your project.clj file:
[gg4clj "0.1.0"]You will need to have R installed, and on your path so it's accessible from the command line. If you can run Rscript
from the command line, then you should be good to go. You will also need to make sure that the ggplot2 library is
installed in R, which you can do by running the following in R (you only need to do this once):
install.packages("ggplot2")Central to gg4clj is a straightforward mapping of R code to Clojure data. There are only a few rules:
- R symbols are represented by Clojure keywords.
- R strings are represented by Clojure strings.
- All other Clojure types, for instance numbers, will be
pr-stred and fed to R. - R function calls are represented by Clojure vectors, with the function name as the first element, and the (positional) arguments as subsequent elements.
- The last argument to a function call can be a map, which is used to represent named arguments.
So, for instance [:qplot :mpg :hp {:data :mtcars :color [:factor :cyl]}] translates to
qplot(mpg, hp, data = mtcars, color = factor(cyl)). The function to-r can be used to show what R code is generated
for a given data structure, and is useful for debugging.
A few additional helper functions are provided for manipulating R code. The function data-frame takes a Clojure map,
whose values are (equal length) seqs of data, and constructs an R data.frame with map keys as column names,
and map values as corresponding column data. Row names can be passed as a :row.names entry in this map. Note that this
function generates Clojure data corresponding to the R code that would generate the data.frame. This might seem
confusing, but it makes sense when considering using it for plotting (see examples).
ggplot2 makes extensive use of the + operator for adding layers etc. This is represented in Clojure data with a :+
function i.e. [:+ thing1 thing2]. However, R's + operator is at most binary, so this is inconvenient for adding more
than two things. To help with this gg4clj provides the r+ function which will take any number of arguments, and
construct the R code which adds them together. For example, (gg4clj/r+ :a :b :c) evaluates to [:+ [:+ :a :b] :c].
The function render does the work of sending code to R for evaluation. It takes a Clojure data structure, representing
some R code and:
- Prefixes it with code to load ggplot2.
- Postfixes it with code to save the last generated plot to a temporary file.
- Sends the code to R for evaluation, reads the generated plot, and cleans up.
It returns a string which is the plot rendered as SVG. It can take options (currently :width and :height) to control
the rendered output. Each evaluation is done in a new R process.
Finally, the function view integrates the above into Gorilla REPL. It manages wrapping the generated plot for
rendering in Gorilla, and takes care of attaching the Clojure form of the R code as the plot's alternate value, so that
value copy-and-paste works seamlessly. It is called in the same manner as render.
For examples of how to put all of the above functions together, please refer to the examples in the demo worksheet:
http://viewer.gorilla-repl.org/view.html?source=github&user=JonyEpsilon&repo=gg4clj&path=ws/demo.clj
gg4clj is licensed to you under the MIT licence. See LICENCE.txt for details.
Copyright © 2014- Jony Hudson