mantao/Plots.jl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

readme

Browse Source
This commit is contained in:
Thomas Breloff 2015-09-12 22:38:56 -04:00
parent ccae6373be
commit 0a88518188
1 changed files with 84 additions and 83 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

167
README.md
View File

@ -60,123 +60,124 @@ Call `plotter!(backend::Symbol)` or the shorthands (`gadfly!()`, `qwt!()`, `unic
Subsequent commands are converted into the relevant plotting commands for that package: Subsequent commands are converted into the relevant plotting commands for that package:
```julia ```julia
gadfly!() gadfly!()
plot(1:10) # this effectively calls `y = 1:10; Gadfly.plot(x=1:length(y), y=y)` plot(1:10) # this effectively calls `y = 1:10; Gadfly.plot(x=1:length(y), y=y)`
qwt!() qwt!()
plot(1:10) # this effectively calls `Qwt.plot(1:10)` 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: Use `plot` to create a new plot object, and `plot!` to add to an existing one:
```julia ```julia
plot(args...; kw...) # creates a new plot window, and sets it to be the `currentPlot` plot(args...; kw...) # creates a new plot window, and sets it to be the `currentPlot`
plot!(args...; kw...) # adds to the `currentPlot` plot!(args...; kw...) # adds to the `currentPlot`
plot!(plotobj, args...; kw...) # adds to the plot `plotobj` 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. 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): Here are some various args to supply, and the implicit mapping (AVec == AbstractVector and AMat == AbstractMatrix):
```julia ```julia
plot(y::AVec; kw...) # one line... x = 1:length(y) plot(y::AVec; kw...) # one line... x = 1:length(y)
plot(x::AVec, y::AVec; kw...) # one line (will assert length(x) == length(y)) plot(x::AVec, y::AVec; kw...) # one line (will assert length(x) == length(y))
plot(y::AMat; 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 = 1:size(y,1)
plot(x::AVec, 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), all sharing x (will assert length(x) == size(y,1))
plot(x::AMat, y::AMat; kw...) # multiple lines (one per column of x/y... will assert size(x) == size(y)) plot(x::AMat, y::AMat; kw...) # multiple lines (one per column of x/y... will assert size(x) == size(y))
plot(f::Function, xmin::Real, xmax::Real; kw...) # one line, map function for range [xmin,xmax] plot(f::Function, xmin::Real, xmax::Real; kw...) # one line, map function for range [xmin,xmax]
plot(f::AVec{Function}, xmin::Real, xmax::Real; kw...) # multiple lines, map functions for range [xmin,xmax] plot(f::AVec{Function}, xmin::Real, xmax::Real; kw...) # multiple lines, map functions for range [xmin,xmax]
plot(fx::Function, fy::Function, umin::Real, umax::Real; kw...) # parametric plot... x = fx(u), y = fy(u) plot(fx::Function, fy::Function, umin::Real, umax::Real; kw...) # parametric plot... x = fx(u), y = fy(u)
plot(x::AVec, f::Function; kw...) # one line, y = f(x)... can swap x and f plot(x::AVec, f::Function; kw...) # one line, y = f(x)... can swap x and f
plot(x::AMat, f::Function; kw...) # multiple lines, yᵢⱼ = f(xᵢⱼ)... can swap f and x plot(x::AMat, f::Function; kw...) # multiple lines, yᵢⱼ = f(xᵢⱼ)... can swap f and x
plot(x::AVec, fs::AVec{Function}; kw...) # multiple lines, yᵢⱼ = fⱼ(xᵢ) plot(x::AVec, fs::AVec{Function}; kw...) # multiple lines, yᵢⱼ = fⱼ(xᵢ)
plot(y::AVec{AVec}; kw...) # multiple lines, each with x = 1:length(y[i]) plot(y::AVec{AVec}; kw...) # multiple lines, each with x = 1:length(y[i])
plot(x::AVec, 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) == length(y[i])
plot(x::AVec{AVec}, y::AVec{AVec}; kw...) # multiple lines, will assert length(x[i]) == length(y[i]) plot(x::AVec{AVec}, y::AVec{AVec}; kw...) # multiple lines, will assert length(x[i]) == length(y[i])
plot(n::Integer; kw...) # n lines, all empty (for updating plots) plot(n::Integer; kw...) # n lines, all empty (for updating plots)
# TODO: how do we handle NA values in dataframes? # TODO: how do we handle NA values in dataframes?
plot(df::DataFrame; kw...) # one line per DataFrame column, labels == names(df) plot(df::DataFrame; kw...) # one line per DataFrame column, labels == names(df)
plot(df::DataFrame, columns; kw...) # one line per column, but on a subset of column names plot(df::DataFrame, columns; kw...) # one line per column, but on a subset of column names
``` ```
With `subplot`, create multiple plots at once, with flexible layout options: With `subplot`, create multiple plots at once, with flexible layout options:
```julia ```julia
y = rand(100,3) y = rand(100,3)
subplot(y; n = 3) # create an automatic grid, and let it figure out the nr/nc... will put plots 1 and 2 on the first row, and plot 3 by itself on the 2nd row 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 to 1 (so there are n columns) 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 to 1 (so there are n rows) subplot(y; n = 3, nc = 1) # create an automatic grid, but fix the number of columns
subplot(y; layout = [1, 2]) # explicit layout by row... plot #1 goes by itself in the first row, plots 2 and 3 split the 2nd row (note the n kw is unnecessary) 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__: 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. __Tip__: Calling `subplot!` on a `Plot` object, or `plot!` on a `Subplot` object will throw an error.
Shorthands: Shorthands:
```julia ```julia
scatter(args...; kw...) = plot(args...; kw..., linetype = :none, marker = :hexagon) scatter(args...; kw...) = plot(args...; kw..., linetype = :none, marker = :hexagon)
scatter!(args...; kw...) = plot!(args...; kw..., linetype = :none, marker = :hexagon) scatter!(args...; kw...) = plot!(args...; kw..., linetype = :none, marker = :hexagon)
bar(args...; kw...) = plot(args...; kw..., linetype = :bar) bar(args...; kw...) = plot(args...; kw..., linetype = :bar)
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)
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)
heatmap!(args...; kw...) = plot!(args...; kw..., linetype = :heatmap) heatmap!(args...; kw...) = plot!(args...; kw..., linetype = :heatmap)
``` ```
Some keyword arguments you can set: Some keyword arguments you can set:
``` ```
axis # :left or :right 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) 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 label # string or symbol, applies to that line, may go in a legend
width # width of a line width # width of a line
linetype # :line, :step, :stepinverted, :sticks, :dots, :none, :heatmap, :hexbin, :hist, :bar linetype # :line, :step, :stepinverted, :sticks, :dots, :none, :heatmap, :hexbin, :hist, :bar
linestyle # :solid, :dash, :dot, :dashdot, :dashdotdot linestyle # :solid, :dash, :dot, :dashdot, :dashdotdot
marker # :none, :ellipse, :rect, :diamond, :utriangle, :dtriangle, :cross, :xcross, :star1, :star2, :hexagon 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` markercolor # same choices as `color`, or :match will set the color to be the same as `color`
markersize # size of the marker markersize # size of the marker
nbins # number of bins for heatmap/hexbin and histograms nbins # number of bins for heatmap/hexbin and histograms
heatmap_c # color cutoffs for Qwt heatmaps heatmap_c # color cutoffs for Qwt heatmaps
fillto # fillto value for area plots fillto # fillto value for area plots
title # string or symbol, title of the plot title # string or symbol, title of the plot
xlabel # string or symbol, label on the bottom (x) axis xlabel # string or symbol, label on the bottom (x) axis
ylabel # string or symbol, label on the left (y) axis ylabel # string or symbol, label on the left (y) axis
yrightlabel # string or symbol, label on the right (y) axis yrightlabel # string or symbol, label on the right (y) axis
reg # true or false, add a regression line for each line reg # true or false, add a regression line for each line
size # (Int,Int), resize the enclosing window size # (Int,Int), resize the enclosing window
pos # (Int,Int), move the enclosing window to this position pos # (Int,Int), move the enclosing window to this position
windowtitle # string or symbol, set the title of the enclosing windowtitle windowtitle # string or symbol, set the title of the enclosing windowtitle
screen # Integer, move enclosing window to this screen number (for multiscreen desktops) screen # Integer, move enclosing window to this screen number (for multiscreen desktops)
show # true or false, show the plot (in case you don't want the window to pop up right away) show # true or false, show the plot (in case you don't want the window to pop up right away)
``` ```
If you don't include a keyword argument, these are the defaults: If you don't include a keyword argument, these are the defaults:
``` ```
axis = :left axis = :left
color = :auto color = :auto
label = automatically generated (y1, y2, ...., or y1 (R), y2 (R) for the right axis) label = automatically generated (y1, y2, ...., or y1 (R), y2 (R) for the right axis)
width = 1 width = 1
linetype = :line linetype = :line
linestype = :solid linestype = :solid
marker = :none marker = :none
markercolor = :match markercolor = :match
markersize = 3 markersize = 3
nbins = 100 nbins = 100
heatmap_c = (0.15, 0.5) heatmap_c = (0.15, 0.5)
fillto = nothing fillto = nothing
title = "" title = ""
xlabel = "" xlabel = ""
ylabel = "" ylabel = ""
yrightlabel = "" yrightlabel = ""
reg = false reg = false
size = (800,600) size = (800,600)
pos = (0,0) pos = (0,0)
windowtitle = "" windowtitle = ""
screen = 1 screen = 1
show = true show = true
``` ```
__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__: You can see the default value for a given argument with `plotDefault(arg::Symbol)`, and set the default value with `plotDefault!(arg::Symbol, value)`
@ -185,7 +186,7 @@ __Tip__: When plotting multiple lines, you can give every line the same trait by
(yes I know it's not gramatically correct, but it's easy to use and implement) (yes I know it's not gramatically correct, but it's easy to use and implement)
```julia ```julia
plot(rand(100,2); colors = [:red, RGB(.5,.5,0)], axiss = [:left, :right], width = 5) # note the width=5 is applied to both lines plot(rand(100,2); colors = [:red, RGB(.5,.5,0)], axiss = [:left, :right], width = 5) # note the width=5 is applied to both lines
``` ```
# TODO # TODO