282 lines
9.0 KiB
Markdown
282 lines
9.0 KiB
Markdown
# Plots
|
|
|
|
[](https://travis-ci.org/tbreloff/Plots.jl)
|
|
|
|
#### Author: Thomas Breloff (@tbreloff)
|
|
|
|
Plotting interface and wrapper for several plotting packages.
|
|
|
|
Please add wishlist items, bugs, or any other comments/questions to the issues list.
|
|
|
|
## Examples for each implemented backend:
|
|
|
|
- [Qwt.jl](docs/qwt_examples.md)
|
|
- [Gadfly.jl](docs/gadfly_examples.md)
|
|
- [UnicodePlots.jl](docs/unicodeplots_examples.md)
|
|
- [PyPlot.jl](docs/pyplot_examples.md)
|
|
- [Immerse.jl](docs/immerse_examples.md)
|
|
- [Winston.jl](docs/winston_examples.md)
|
|
|
|
## Installation
|
|
|
|
First, add the package
|
|
|
|
```julia
|
|
Pkg.add("Plots")
|
|
```
|
|
|
|
then get any plotting packages you need (obviously, you should get at least one backend):
|
|
|
|
```julia
|
|
Pkg.add("Gadfly")
|
|
Pkg.add("Immerse")
|
|
Pkg.add("UnicodePlots")
|
|
Pkg.add("PyPlot") # requires python and matplotlib
|
|
Pkg.clone("https://github.com/tbreloff/Qwt.jl.git") # requires pyqt and pyqwt
|
|
Pkg.add("Winston")
|
|
```
|
|
|
|
## Use
|
|
|
|
Load it in. The underlying plotting backends are not imported until `plotter()` is called (which happens
|
|
on your first call to `plot` or `subplot`). This means that you don't need any backends to be installed when you call `using Plots`.
|
|
Plots will try to figure out a good default backend for you automatically based on what backends are installed.
|
|
|
|
```julia
|
|
using Plots
|
|
```
|
|
|
|
Do a plot in Gadfly, then save a png:
|
|
|
|
```julia
|
|
# switch to Gadfly as a backend
|
|
gadfly!()
|
|
|
|
# This will bring up a browser window with the plot. Add a semicolon to skip display.
|
|
plot(rand(10,2); marker = :rect, markersizes=[10,30])
|
|
|
|
# save it as a PNG
|
|
savepng(Plots.IMG_DIR * "gadfly1.png")
|
|
```
|
|
|
|
which saves:
|
|
|
|
|
|
|
|
See the examples pages for lots of examples of plots, and what those commands produce for each supported backend.
|
|
|
|
## API
|
|
|
|
Call `plotter!(backend::Symbol)` or the shorthands (`gadfly!()`, `qwt!()`, `unicodeplots!()`, etc) to set the current plotting backend.
|
|
Subsequent commands are converted into the relevant plotting commands for that package:
|
|
|
|
```julia
|
|
gadfly!()
|
|
plot(1:10) # this effectively calls `y = 1:10; Gadfly.plot(x=1:length(y), y=y)`
|
|
qwt!()
|
|
plot(1:10) # this effectively calls `Qwt.plot(1:10)`
|
|
```
|
|
|
|
Use `plot` to create a new plot object, and `plot!` to add to an existing one:
|
|
|
|
```julia
|
|
plot(args...; kw...) # creates a new plot window, and sets it to be the `currentPlot`
|
|
plot!(args...; kw...) # adds to the `currentPlot`
|
|
plot!(plotobj, args...; kw...) # adds to the plot `plotobj`
|
|
```
|
|
|
|
Now that you know which plot object you're updating (new, current, or other), I'll leave it off for simplicity.
|
|
Here are some various args to supply, and the implicit mapping (AVec == AbstractVector and AMat == AbstractMatrix):
|
|
|
|
```julia
|
|
# one line... x = 1:length(y)
|
|
plot(y::AVec; kw...)
|
|
|
|
# one line (will assert length(x) == length(y))
|
|
plot(x::AVec, y::AVec; kw...)
|
|
|
|
# multiple lines (one per column of x), all sharing x = 1:size(y,1)
|
|
plot(y::AMat; kw...)
|
|
|
|
# multiple lines (one per column of x), all sharing x (will assert length(x) == size(y,1))
|
|
plot(x::AVec, y::AMat; kw...)
|
|
|
|
# multiple lines (one per column of x/y... will assert size(x) == size(y))
|
|
plot(x::AMat, y::AMat; kw...)
|
|
|
|
# one line, map function for range [xmin,xmax]
|
|
plot(f::Function, xmin::Real, xmax::Real; kw...)
|
|
|
|
# multiple lines, map functions for range [xmin,xmax]
|
|
plot(f::AVec{Function}, xmin::Real, xmax::Real; kw...)
|
|
|
|
# parametric plot... x = fx(u), y = fy(u)
|
|
plot(fx::Function, fy::Function, umin::Real, umax::Real; kw...)
|
|
|
|
# one line, y = f(x)... can swap x and f
|
|
plot(x::AVec, f::Function; kw...)
|
|
|
|
# multiple lines, yᵢⱼ = f(xᵢⱼ)... can swap f and x
|
|
plot(x::AMat, f::Function; kw...)
|
|
|
|
# multiple lines, yᵢⱼ = fⱼ(xᵢ)
|
|
plot(x::AVec, fs::AVec{Function}; kw...)
|
|
|
|
# multiple lines, each with x = 1:length(y[i])
|
|
plot(y::AVec{AVec}; kw...)
|
|
|
|
# multiple lines, will assert length(x) == length(y[i])
|
|
plot(x::AVec, y::AVec{AVec}; kw...)
|
|
|
|
# multiple lines, will assert length(x[i]) == length(y[i])
|
|
plot(x::AVec{AVec}, y::AVec{AVec}; kw...)
|
|
|
|
# n lines, all empty (for updating plots)
|
|
plot(n::Integer; kw...)
|
|
|
|
# TODO: DataFrames, categorical values
|
|
```
|
|
|
|
With `subplot`, create multiple plots at once, with flexible layout options:
|
|
|
|
```julia
|
|
y = rand(100,3)
|
|
subplot(y; n = 3) # create an automatic grid, and let it figure out the shape
|
|
subplot(y; n = 3, nr = 1) # create an automatic grid, but fix the number of rows
|
|
subplot(y; n = 3, nc = 1) # create an automatic grid, but fix the number of columns
|
|
subplot(y; layout = [1, 2]) # explicit layout. Lists the number of plots in each row
|
|
```
|
|
|
|
__Tip__: You can call `subplot!(args...; kw...)` to add to an existing subplot.
|
|
|
|
__Tip__: Calling `subplot!` on a `Plot` object, or `plot!` on a `Subplot` object will throw an error.
|
|
|
|
Shorthands:
|
|
|
|
```julia
|
|
scatter(args...; kw...) = plot(args...; kw..., linetype = :scatter)
|
|
scatter!(args...; kw...) = plot!(args...; kw..., linetype = :scatter)
|
|
bar(args...; kw...) = plot(args...; kw..., linetype = :bar)
|
|
bar!(args...; kw...) = plot!(args...; kw..., linetype = :bar)
|
|
histogram(args...; kw...) = plot(args...; kw..., linetype = :hist)
|
|
histogram!(args...; kw...) = plot!(args...; kw..., linetype = :hist)
|
|
heatmap(args...; kw...) = plot(args...; kw..., linetype = :heatmap)
|
|
heatmap!(args...; kw...) = plot!(args...; kw..., linetype = :heatmap)
|
|
sticks(args...; kw...) = plot(args...; kw..., linetype = :sticks, marker = :ellipse)
|
|
sticks!(args...; kw...) = plot!(args...; kw..., linetype = :sticks, marker = :ellipse)
|
|
```
|
|
|
|
Some keyword arguments you can set:
|
|
|
|
```
|
|
axis # :left or :right
|
|
color # can be a string ("red") or a symbol (:red) or a ColorsTypes.jl
|
|
# Colorant (RGB(1,0,0)) or :auto (which lets the package pick)
|
|
label # string or symbol, applies to that line, may go in a legend
|
|
width # width of a line
|
|
linetype # :line, :step, :stepinverted, :sticks, :scatter, :none, :heatmap, :hexbin, :hist, :bar
|
|
linestyle # :solid, :dash, :dot, :dashdot, :dashdotdot
|
|
marker # :none, :ellipse, :rect, :diamond, :utriangle, :dtriangle,
|
|
# :cross, :xcross, :star1, :star2, :hexagon
|
|
markercolor # same choices as `color`, or :match will set the color to be the same as `color`
|
|
markersize # size of the marker
|
|
nbins # number of bins for heatmap/hexbin and histograms
|
|
heatmap_c # color cutoffs for Qwt heatmaps
|
|
fillto # fillto value for area plots
|
|
title # string or symbol, title of the plot
|
|
xlabel # string or symbol, label on the bottom (x) axis
|
|
ylabel # string or symbol, label on the left (y) axis
|
|
yrightlabel # string or symbol, label on the right (y) axis
|
|
reg # true or false, add a regression line for each line
|
|
size # (Int,Int), resize the enclosing window
|
|
pos # (Int,Int), move the enclosing window to this position
|
|
windowtitle # string or symbol, set the title of the enclosing windowtitle
|
|
screen # Integer, move enclosing window to this screen number (for multiscreen desktops)
|
|
```
|
|
|
|
Note that not every backend supports all options.
|
|
|
|
If you don't include a keyword argument, these are the defaults:
|
|
|
|
```
|
|
axis = :left
|
|
color = :auto
|
|
label = automatically generated (y1, y2, ...., or y1 (R), y2 (R) for the right axis)
|
|
width = 1
|
|
linetype = :line
|
|
linestype = :solid
|
|
marker = :none
|
|
markercolor = :match
|
|
markersize = 3
|
|
nbins = 100
|
|
heatmap_c = (0.15, 0.5)
|
|
fillto = nothing
|
|
title = ""
|
|
xlabel = ""
|
|
ylabel = ""
|
|
yrightlabel = ""
|
|
reg = false
|
|
size = (600,400)
|
|
pos = (0,0)
|
|
windowtitle = "Plots.jl"
|
|
screen = 1
|
|
```
|
|
|
|
__Tip__: You can see the default value for a given argument with `plotDefault(arg::Symbol)`, and set the default value with `plotDefault!(arg::Symbol, value)`
|
|
|
|
__Tip__: When plotting multiple lines, you can give every line the same trait by using the singular, or add an "s" to pluralize.
|
|
(yes I know it's not gramatically correct, but it's easy to use and implement)
|
|
|
|
```julia
|
|
# Note: The same width is applied to both lines, whereas
|
|
# each line gets different color and axis.
|
|
plot(rand(100,2); colors = [:red, RGB(.5,.5,0)],
|
|
axiss = [:left, :right],
|
|
width = 5)
|
|
```
|
|
|
|
## TODO features:
|
|
|
|
- [x] Plot vectors/matrices/functions
|
|
- [ ] Plot DataFrames
|
|
- [ ] Scales
|
|
- [ ] Categorical Inputs (strings, etc... for hist, bar? or can split one series into multiple?)
|
|
- [ ] Custom markers
|
|
- [ ] Special plots (boxplot, ohlc?)
|
|
- [x] Subplots
|
|
- [x] Histograms
|
|
- [ ] 3D plotting
|
|
- [ ] Scenes/Drawing
|
|
- [ ] Graphs
|
|
- [ ] Interactivity (GUIs)
|
|
|
|
## TODO backends:
|
|
|
|
- [x] Gadfly.jl
|
|
- [x] Immerse.jl
|
|
- [x] PyPlot.jl
|
|
- [x] UnicodePlots.jl
|
|
- [x] Qwt.jl
|
|
- [x] Winston.jl
|
|
- [ ] GLPlot.jl
|
|
- [ ] Bokeh.jl
|
|
- [ ] Vega.jl
|
|
- [ ] Gaston.jl
|
|
- [ ] Plotly.jl
|
|
- [ ] GoogleCharts.jl
|
|
- [ ] PLplot.jl
|
|
- [ ] TextPlots.jl
|
|
- [ ] ASCIIPlots.jl
|
|
- [ ] Sparklines.jl
|
|
- [ ] Hinton.jl
|
|
- [ ] ImageTerm.jl
|
|
- [ ] GraphViz.jl
|
|
- [ ] TikzGraphs.jl
|
|
- [ ] GraphLayout.jl
|
|
|
|
## More information on backends (both supported and unsupported)
|
|
|
|
See the wiki at: https://github.com/JuliaPlot/juliaplot_docs/wiki
|
|
|
|
|