A collection of clean plotting methods for easy Julia figures.
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.
doc
src
test
.gitignore
.travis.yml
LICENSE.md
README.md
REQUIRE
appveyor.yml

README.md

SimplePlot

Build Status

A collection of plotting methods designed to have a very simple and clean interface.

line(rand(10))
axis(
    bar(rand(10), label="A"),
    bar(rand(10), label="B")
)
scatter(rand(10), rand(10), xlabel="random")

Installation

Pkg.clone("https://github.com/slundberg/SimplePlot.jl.git")

SimplePlot is based on PyPlot.jl, which must also be installed and working with a matplotlib version greater than 1.4.3.

Usage

SimplePlot is based on the following nested structure of components:

plot > grid ... grid > axis > layer

Every plot has a single grid object, every grid object has one or more grid or axis objects, each axis object has one or more layers. Writing this out explictly for a line plot gives:

using SimplePlot
plot(grid(1, 1, axis(line(1:10, rand(10)))))

Auto-wrapping

SimplePlot is designed to provide defaults for almost everything. This means that when we try to display a line layer it will be auto-wrapped in an axis, which will be auto-wrapped in a grid, which will be auto-wrapped in a plot. This means in practice we only need to specify the layer we care about, and SimplePlot will add the rest:

line(1:10, rand(10))

Parameter delegation

While auto-wrapping makes it easy to specify layers, what if we want to set an axis parameter? We could be explicit and write:

axis(line(1:10, rand(10)), xlabel="index")

But with parameter delagation any parameters not claimed by an object are passed to containing objects until they are claimed. This means we can set the xlabel parameter on the line layer and it will get automatically picked up by the auto-generated axis object during display. This makes simple plots simple, while still maintaining strict order and stucture:

line(1:10, rand(10), xlabel="index")

The same thing works for paremeters given to higher containers, children can claim an unused parameter from a parent object. This makes it easy to set common parameters across many layers:

axis(
    line(1:10, rand(10)),
    line(1:10, rand(10)),
    line(1:10, rand(10)),
    linewidth=2
)

Documentation

Below is a set of examples that illustrate many of the options available. However, for now, taking a quick look at the source is the best way to see all the supported options. Since everything is based on matplotlib, it is also easy to add new options if the current ones don't meet a need. PR's are welcome.

Plot

plot(
    line(1:4, [8,3,5,1], "B"),
    figsize=(5,3)
)

Grid

grid(1,2,
    line(1:4, [3,6,2,4], "A"),
    line(1:4, [8,3,5,1], "B")
)

Axis

axis(
    line(1:4, [3,6,2,4], "A"),
    line(1:4, [8,3,5,1], "B"),
    legend="upper right",
    ylabel="x axis",
    ylabel="y axis",
    stacked=false,
    xtickrotation="horizontal",
    xticklabels=true,
    ylim=(0,10),
    xlim=(1,4)
)

Line layer

line(1:4, [3,6,2,4], "A", color="#ffff00", alpha=0.8)

Bar layer

bar(["G1", "G2", "G3", "G4"], [3,6,2,4], "Label", color="#000000", alpha=0.8)

Horizontal Bar layer

hbar(["G1", "G2", "G3", "G4"], [3,6,2,4])

Scatter layer

scatter(1:4, [3,6,2,4], markerarea=0.8)

Histogram layer

histplot(randn(1000), bins=10, histtype="bar")

Matrix layer

matplot(rand(10,20))

Area layer

area(1:10, rand(10), zeros(10))