examples

docs/example_generation.jl

@@ -103,7 +103,7 @@ function generate_markdown(pkgname::Symbol)
   md = open("$DOCDIR/$(pkgname)_examples.md", "w")
 
   write(md, "# Examples for backend: $pkgname\n\n")
-  write(md, "- Supported arguments: $(supportedArgs(pkg))\n")
+  write(md, "- Supported arguments: $(join(supportedArgs(pkg), ", "))\n")
   write(md, "- Supported values for axis: $(supportedAxes(pkg))\n")
   write(md, "- Supported values for linetype: $(supportedTypes(pkg))\n")
   write(md, "- Supported values for linestyle: $(supportedStyles(pkg))\n")
@@ -173,9 +173,9 @@ end
 
 # run it!
 # note: generate separately so it's easy to comment out
+# @osx_only generate_markdown(:unicodeplots)
 # generate_markdown(:qwt)
 # generate_markdown(:gadfly)
-# @osx_only generate_markdown(:unicodeplots)
 # generate_markdown(:pyplot)
 # generate_markdown(:immerse)
 

docs/gadfly_examples.md

@@ -1,10 +1,10 @@
 # Examples for backend: gadfly
 
-- Supported arguments: [:args,:axis,:color,:fillto,:heatmap_c,:kwargs,:label,:legend,:linestyle,:linetype,:marker,:markercolor,:markersize,:nbins,:reg,:size,:title,:width,:windowtitle,:xlabel,:ylabel,:yrightlabel]
+- Supported arguments: args, axis, color, fillto, heatmap_c, kwargs, label, legend, linestyle, linetype, marker, markercolor, markersize, nbins, reg, size, title, width, windowtitle, xlabel, ylabel, yrightlabel
-- Supported values for axis: [:left]
+- Supported values for axis: [:auto,:left]
 - Supported values for linetype: [:line,:step,:sticks,:scatter,:heatmap,:hexbin,:hist,:bar]
-- Supported values for linestyle: [:solid]
+- Supported values for linestyle: [:auto,:solid]
-- Supported values for marker: [:rect,:ellipse,:diamond,:cross]
+- Supported values for marker: [:none,:auto,:rect,:ellipse,:diamond,:cross]
 - Is `subplot`/`subplot!` supported? Yes
 
 ### Lines
@@ -116,11 +116,11 @@ heatmap(randn(10000),randn(10000); nbins=100)
 All options: (:line, :orderedline, :step, :stepinverted, :sticks, :scatter, :none, :heatmap, :hexbin, :hist, :bar)
 
 ```julia
-types = intersect(supportedTypes(),[:line,:orderedline,:path,:step,:stepinverted,:sticks,:scatter])
+types = intersect(supportedTypes(),[:line,:step,:stepinverted,:sticks,:scatter])
 n = length(types)
 x = Vector[sort(rand(20)) for i = 1:n]
 y = rand(20,n)
-plot(x,y; linetype=:auto,labels=map(string,types))
+plot(x,y; linetypes=types,labels=map(string,types))
 ```
 
 ![](../img/gadfly/gadfly_example_11.png)
@@ -130,7 +130,7 @@ plot(x,y; linetype=:auto,labels=map(string,types))
 All options: (:solid, :dash, :dot, :dashdot, :dashdotdot)
 
 ```julia
-styles = supportedStyles()
+styles = setdiff(supportedStyles(),[:auto])
 plot(rand(20,length(styles)); linestyle=:auto,labels=map(string,styles))
 ```
 
@@ -141,7 +141,7 @@ plot(rand(20,length(styles)); linestyle=:auto,labels=map(string,styles))
 All options: (:none, :auto, :ellipse, :rect, :diamond, :utriangle, :dtriangle, :cross, :xcross, :star1, :star2, :hexagon)
 
 ```julia
-markers = supportedMarkers()
+markers = setdiff(supportedMarkers(),[:none,:auto])
 plot([fill(i,10) for i = 1:length(markers)]; marker=:auto,labels=map(string,markers),markersize=10)
 ```
 

docs/immerse_examples.md

@@ -1,3 +1,12 @@
+# Examples for backend: immerse
+
+- Supported arguments: args, axis, color, fillto, heatmap_c, kwargs, label, legend, linestyle, linetype, marker, markercolor, markersize, nbins, reg, size, title, width, windowtitle, xlabel, ylabel, yrightlabel
+- Supported values for axis: [:auto,:left]
+- Supported values for linetype: [:line,:step,:sticks,:scatter,:heatmap,:hexbin,:hist,:bar]
+- Supported values for linestyle: [:auto,:solid]
+- Supported values for marker: [:none,:auto,:rect,:ellipse,:diamond,:cross]
+- Is `subplot`/`subplot!` supported? Yes
+
 ### Lines
 
 A simple line plot of the 3 columns.
@@ -10,7 +19,7 @@ plot(rand(100,3))
 
 ### Functions
 
-Plot multiple functions.
+Plot multiple functions.  You can also put the function first.
 
 ```julia
 plot(0:0.01:4π,[sin,cos])
@@ -30,7 +39,7 @@ plot([sin,cos],0,4π)
 
 ### 
 
-Or make a parametric plot with plot(fx, fy, umin, umax).
+Or make a parametric plot (i.e. plot: (fx(u), fy(u))) with plot(fx, fy, umin, umax).
 
 ```julia
 plot(sin,(x->begin  # /home/tom/.julia/v0.4/Plots/docs/example_generation.jl, line 33:
@@ -54,7 +63,7 @@ plot(rand(10); title="TITLE",xlabel="XLABEL",ylabel="YLABEL",background_color=RG
 
 Use the `axis` or `axiss` arguments.
 
-Note: This is only supported with Qwt right now
+Note: Currently only supported with Qwt and PyPlot
 
 ```julia
 plot(Vector[randn(100),randn(100) * 100]; axiss=[:left,:right],ylabel="LEFT",yrightlabel="RIGHT")
@@ -102,34 +111,37 @@ heatmap(randn(10000),randn(10000); nbins=100)
 
 ![](../img/immerse/immerse_example_10.png)
 
-### Lots of line types
+### Suported line types
 
-Options: (:line, :step, :stepinverted, :sticks, :scatter, :none, :heatmap, :hexbin, :hist, :bar)  
+All options: (:line, :orderedline, :step, :stepinverted, :sticks, :scatter, :none, :heatmap, :hexbin, :hist, :bar)
-Note: some may not work with all backends
 
 ```julia
-plot(rand(20,4); linetypes=[:line,:step,:sticks,:scatter],labels=["line","step","sticks","dots"])
+types = intersect(supportedTypes(),[:line,:step,:stepinverted,:sticks,:scatter])
+n = length(types)
+x = Vector[sort(rand(20)) for i = 1:n]
+y = rand(20,n)
+plot(x,y; linetypes=types,labels=map(string,types))
 ```
 
 ![](../img/immerse/immerse_example_11.png)
 
-### Lots of line styles
+### Supported line styles
 
-Options: (:solid, :dash, :dot, :dashdot, :dashdotdot)  
+All options: (:solid, :dash, :dot, :dashdot, :dashdotdot)
-Note: some may not work with all backends
 
 ```julia
-plot(rand(20,5); linestyles=[:solid,:dash,:dot,:dashdot,:dashdotdot],labels=["solid","dash","dot","dashdot","dashdotdot"])
+styles = setdiff(supportedStyles(),[:auto])
+plot(rand(20,length(styles)); linestyle=:auto,labels=map(string,styles))
 ```
 
 ![](../img/immerse/immerse_example_12.png)
 
-### Lots of marker types
+### Supported marker types
-
 
+All options: (:none, :auto, :ellipse, :rect, :diamond, :utriangle, :dtriangle, :cross, :xcross, :star1, :star2, :hexagon)
 
 ```julia
-markers = supportedMarkers()
+markers = setdiff(supportedMarkers(),[:none,:auto])
 plot([fill(i,10) for i = 1:length(markers)]; marker=:auto,labels=map(string,markers),markersize=10)
 ```
 
@@ -155,3 +167,38 @@ histogram(randn(1000); nbins=50,fillto=20)
 
 ![](../img/immerse/immerse_example_15.png)
 
+### Subplots
+
+  subplot and subplot! are distinct commands which create many plots and add series to them in a circular fashion.
+  You can define the layout with keyword params... either set the number of plots `n` (and optionally number of rows `nr` or 
+  number of columns `nc`), or you can set the layout directly with `layout`.  
+
+  Note: Gadfly is not very friendly here, and although you can create a plot and save a PNG, I haven't been able to actually display it.
+
+
+```julia
+subplot(randn(100,5); layout=[1,1,3],linetypes=[:line,:hist,:scatter,:step,:bar],nbins=10,legend=false)
+```
+
+![](../img/immerse/immerse_example_16.png)
+
+### Adding to subplots
+
+Note here the automatic grid layout, as well as the order in which new series are added to the plots.
+
+```julia
+subplot(randn(100,5); n=4)
+```
+
+![](../img/immerse/immerse_example_17.png)
+
+### 
+
+
+
+```julia
+subplot!(randn(100,3))
+```
+
+![](../img/immerse/immerse_example_18.png)
+

docs/pyplot_examples.md

@@ -1,3 +1,12 @@
+# Examples for backend: pyplot
+
+- Supported arguments: args, axis, color, fillto, heatmap_c, kwargs, label, legend, linestyle, linetype, marker, markercolor, markersize, nbins, reg, size, title, width, windowtitle, xlabel, ylabel, yrightlabel
+- Supported values for axis: [:auto,:left,:right]
+- Supported values for linetype: [:none,:line,:step,:stepinverted,:sticks,:scatter,:heatmap,:hexbin,:hist,:bar]
+- Supported values for linestyle: [:auto,:solid,:dash,:dot,:dashdot]
+- Supported values for marker: [:none,:auto,:ellipse,:rect,:diamond,:utriangle,:dtriangle,:cross,:xcross,:star1,:hexagon]
+- Is `subplot`/`subplot!` supported? No
+
 ### Lines
 
 A simple line plot of the 3 columns.
@@ -10,7 +19,7 @@ plot(rand(100,3))
 
 ### Functions
 
-Plot multiple functions.
+Plot multiple functions.  You can also put the function first.
 
 ```julia
 plot(0:0.01:4π,[sin,cos])
@@ -30,10 +39,10 @@ plot([sin,cos],0,4π)
 
 ### 
 
-Or make a parametric plot with plot(fx, fy, umin, umax).
+Or make a parametric plot (i.e. plot: (fx(u), fy(u))) with plot(fx, fy, umin, umax).
 
 ```julia
-plot(sin,(x->begin  # /Users/tom/.julia/v0.4/Plots/docs/example_generation.jl, line 33:
+plot(sin,(x->begin  # /home/tom/.julia/v0.4/Plots/docs/example_generation.jl, line 33:
             sin(2x)
         end),0,2π)
 ```
@@ -54,7 +63,7 @@ plot(rand(10); title="TITLE",xlabel="XLABEL",ylabel="YLABEL",background_color=RG
 
 Use the `axis` or `axiss` arguments.
 
-Note: This is only supported with Qwt right now
+Note: Currently only supported with Qwt and PyPlot
 
 ```julia
 plot(Vector[randn(100),randn(100) * 100]; axiss=[:left,:right],ylabel="LEFT",yrightlabel="RIGHT")
@@ -102,35 +111,38 @@ heatmap(randn(10000),randn(10000); nbins=100)
 
 ![](../img/pyplot/pyplot_example_10.png)
 
-### Lots of line types
+### Suported line types
 
-Options: (:line, :step, :stepinverted, :sticks, :scatter, :none, :heatmap, :hexbin, :hist, :bar)  
+All options: (:line, :orderedline, :step, :stepinverted, :sticks, :scatter, :none, :heatmap, :hexbin, :hist, :bar)
-Note: some may not work with all backends
 
 ```julia
-plot(rand(20,4); linetypes=[:line,:step,:sticks,:scatter],labels=["line","step","sticks","dots"])
+types = intersect(supportedTypes(),[:line,:step,:stepinverted,:sticks,:scatter])
+n = length(types)
+x = Vector[sort(rand(20)) for i = 1:n]
+y = rand(20,n)
+plot(x,y; linetypes=types,labels=map(string,types))
 ```
 
 ![](../img/pyplot/pyplot_example_11.png)
 
-### Lots of line styles
+### Supported line styles
 
-Options: (:solid, :dash, :dot, :dashdot, :dashdotdot)  
+All options: (:solid, :dash, :dot, :dashdot, :dashdotdot)
-Note: some may not work with all backends
 
 ```julia
-plot(rand(20,5); linestyles=[:solid,:dash,:dot,:dashdot,:dashdotdot],labels=["solid","dash","dot","dashdot","dashdotdot"])
+styles = setdiff(supportedStyles(),[:auto])
+plot(rand(20,length(styles)); linestyle=:auto,labels=map(string,styles))
 ```
 
 ![](../img/pyplot/pyplot_example_12.png)
 
-### Lots of marker types
+### Supported marker types
 
-Options: (:none, :ellipse, :rect, :diamond, :utriangle, :dtriangle, :cross, :xcross, :star1, :star2, :hexagon)  
+All options: (:none, :auto, :ellipse, :rect, :diamond, :utriangle, :dtriangle, :cross, :xcross, :star1, :star2, :hexagon)
-Note: some may not work with all backends
 
 ```julia
-plot(repmat(collect(1:10)',10,1); markers=[:ellipse,:rect,:diamond,:utriangle,:dtriangle,:cross,:xcross,:star1,:star2,:hexagon],labels=["ellipse","rect","diamond","utriangle","dtriangle","cross","xcross","star1","star2","hexagon"],linetype=:none,markersize=10)
+markers = setdiff(supportedMarkers(),[:none,:auto])
+plot([fill(i,10) for i = 1:length(markers)]; marker=:auto,labels=map(string,markers),markersize=10)
 ```
 
 ![](../img/pyplot/pyplot_example_13.png)

docs/qwt_examples.md

@@ -1,6 +1,6 @@
 # Examples for backend: qwt
 
-- Supported arguments: [:args,:axis,:color,:fillto,:heatmap_c,:kwargs,:label,:legend,:linestyle,:linetype,:marker,:markercolor,:markersize,:nbins,:reg,:size,:title,:width,:windowtitle,:xlabel,:ylabel,:yrightlabel]
+- Supported arguments: args, axis, color, fillto, heatmap_c, kwargs, label, legend, linestyle, linetype, marker, markercolor, markersize, nbins, reg, size, title, width, windowtitle, xlabel, ylabel, yrightlabel
 - Supported values for axis: [:auto,:left,:right]
 - Supported values for linetype: [:none,:line,:step,:stepinverted,:sticks,:scatter,:heatmap,:hexbin,:hist,:bar]
 - Supported values for linestyle: [:auto,:solid,:dash,:dot,:dashdot,:dashdotdot]
@@ -120,7 +120,7 @@ types = intersect(supportedTypes(),[:line,:step,:stepinverted,:sticks,:scatter])
 n = length(types)
 x = Vector[sort(rand(20)) for i = 1:n]
 y = rand(20,n)
-plot(x,y; linetype=:auto,labels=map(string,types))
+plot(x,y; linetypes=types,labels=map(string,types))
 ```
 
 ![](../img/qwt/qwt_example_11.png)