Merge pull request #3 from snotskie/master

Added basic DataFrames support, Travis testing, and Plotly.line, etc. functions

Author: bpostlethwaite

.travis.yml

@@ -0,0 +1,15 @@
+language: cpp
+compiler: 
+    - clang
+notifications:
+    email: false
+env:
+    matrix: 
+        - JULIAVERSION="julianightlies" 
+before_install:
+    - sudo add-apt-repository ppa:staticfloat/julia-deps -y
+    - sudo add-apt-repository ppa:staticfloat/${JULIAVERSION} -y
+    - sudo apt-get update -qq -y
+    - sudo apt-get install libpcre3-dev julia -y
+script:
+    - julia -e 'Pkg.init(); Pkg.clone(pwd()); Pkg.test("Plotly")'

README.md

@@ -1,4 +1,6 @@
-#A Julia interface to the plot.ly API
+# A Julia interface to the plot.ly API
+
+[![Build Status](https://travis-ci.org/snotskie/Plotly.jl.png)](https://travis-ci.org/snotskie/Plotly.jl)
 
 Forked from [astrieanna/Plotly.jl](https://github.com/astrieanna/Plotly.jl)
 
@@ -8,62 +10,152 @@ README quickly to get started. Alternately, checkout out the pretty Julia docs a
 
 Given that you have Julia v0.2.1,
 
-    Pkg.clone("https://github.com/plotly/Plotly.jl")
+```julia
+Pkg.clone("https://github.com/plotly/Plotly.jl")
+```
 
 ## Usage
-
-    julia> using Plotly
-    INFO: Cloning Plotly from https://github.com/plotly/Plotly.jl
-    INFO: Computing changes...
-    INFO: No packages to install, update or remove.
-
+```julia
+julia> using Plotly
+INFO: Cloning Plotly from https://github.com/plotly/Plotly.jl
+INFO: Computing changes...
+INFO: No packages to install, update or remove.
+```
 
 You'll need to create a plot.ly account and find out your API key before you'll be able to use this package.
+
 ## New user signup
-    julia> Plotly.signup("username","email")
-    Success! Check your email to activate account.
-    
+```julia
+julia> Plotly.signup("username","email")
+Success! Check your email to activate account.
+```
+
 ## Signin 
-    julia> Plotly.signin("username","your api key")
-    PlotlyAccount("username","your api key")
+```julia
+julia> Plotly.signin("username","your api key")
+PlotlyAccount("username","your api key")
+```
 
 ## Plot && Open in browser
-    julia> Plotly.openurl(Plotly.plot(["z"=>rand(6,6)],["style"=>["type"=>"heatmap"]]))
-    START /bin/firefox "https://plot.ly/~astrieanna/0"
-    
+```julia
+julia> Plotly.openurl(Plotly.plot(["z"=>rand(6,6)],["style"=>["type"=>"heatmap"]]))
+START /bin/firefox "https://plot.ly/~astrieanna/0"
+```
+
 That last line is what the REPL prints out,
 as a Firefox tab opens with the plot.
 You can also just call `plot` by itself, and you'll get a String that's the url of your chart.
 
 ## Style and Layout
-    julia> Plotly.style(["line"=>["color"=>"rgb(255,0,0)","width"=>10]])
-    
-    julia> Plotly.layout(["layout"=>["title"=>"Time Wasted"]])
-
-## Plot Functions and Polynomials
-    julia> Plotly.plot(abs)
-    julia> Plotly.plot([sqrt, log], ["left"=>10, "right"=>20, "step"=>0.1])
+```julia
+julia> Plotly.style(["line"=>["color"=>"rgb(255,0,0)","width"=>10]])
+julia> Plotly.layout(["layout"=>["title"=>"Time Wasted"]])
+```
+
+# Quick Plotting
+## Functions and Polynomials
+```julia
+julia> Plotly.plot(abs)
+julia> Plotly.plot([sqrt, log], ["left"=>10, "right"=>20, "step"=>0.1])
+julia> Plotly.plot() do x
+       savings = 3000
+       income = x*1000
+       expenses = x*800
+       return savings+income-expenses
+       end
+```
 
 You can now plot functions directly.
 The first line shows how to plot the absolute value function, and the second line plots
 the square root and logarithm functions, both from 10 to 20 at increments of 0.1.
+The last line shows how to use Julia's `do` syntax to plot complicated anonymous functions.
 
-    julia> using Polynomial
-    julia> x = Poly([1,0])
-    julia> Plotly.plot(3x^3 + 2x^2 - x + 1)
+```julia
+julia> using Polynomial
+julia> x = Poly([1,0])
+julia> Plotly.plot(3x^3 + 2x^2 - x + 1)
+julia> Plotly.plot([x, 2x, 3x^2-x])
+```
 
-If you have the Polynomial package installed, you can plot them directly the same way as math functions.
+Using the Polynomial package, you can plot polynomials directly the same way as math functions.
 
-## Plot TimeSeries
-    julia> using TimeSeries
-    julia> d = [date(2012,5,29):date(2013,5,29)]
-    julia> t = TimeArray(d, rand(length(d),2), ["foo","bar"])
-    julia> Plotly.plot(t)
-
-If you have the TimeSeries package installed, you can plot them directly by passing a TimeArray argument.
-
-## Plot WAV Files
-    julia> using WAV
-    julia> Plotly.plot(wavread("filename.wav"))
-
-If you have the WAV package installed, you can plot WAV files by passing a call to the wavread function.
+## DataFrames and TimeSeries
+```julia
+julia> using DataFrames
+julia> df = readtable("height_vs_weight.csv")
+julia> Plotly.plot(df, ["xs"=>:height, "ys"=>:weight])
+```
+
+Using the DataFrames package, you can read CSV data and plot it directly by passing the data frame and setting the xs and/or ys options. These are symbols or arrays of symbols refering to columns names in the CSV file.
+
+```julia
+julia> using TimeSeries
+julia> d = [date(2012,5,29):date(2013,5,29)]
+julia> t = TimeArray(d, rand(length(d),2), ["foo","bar"])
+julia> Plotly.plot(t)
+```
+
+Using the TimeSeries package, you can plot them directly by passing a TimeArray argument.
+
+## WAV Files
+```julia
+julia> using WAV
+julia> Plotly.plot(wavread("filename.wav"))
+```
+
+Using the WAV package, you can plot WAV files by passing a call to the `wavread` function.
+
+# Detailed Plotting
+## Arrays and Dicts
+```julia
+julia> trace1 = Plotly.line([3x for x in 1:1000])
+julia> trace2 = Plotly.histogram([3x for x in 1:1000])
+julia> trace3 = Plotly.scatter([2x => 3x for x in 1:1000])
+julia> trace4 = Plotly.box([2x => 3x for x in 1:1000])
+julia
+```
+
+## Functions and Polynomials
+```julia
+julia> trace1 = Plotly.line(abs, ["left"=>10, "right"=>20, "step"=>0.1])
+julia> trace2 = Plotly.box(sin, ["left"=>10, "right"=>20, "step"=>0.1])
+julia> trace3 = Plotly.scatter(cos, ["left"=>10, "right"=>20, "step"=>0.1])
+julia> trace4 = Plotly.histogram(cos, ["left"=>10, "right"=>20, "step"=>0.1])
+julia> Plotly.plot([trace1, trace2, trace3, trace4])
+
+julia> using Polynomial
+julia> x = Poly([1,0])
+julia> trace1 = Plotly.line(3x^3 + 2x^2 - x + 1)
+julia> trace2 = Plotly.histogram(3x^3 + 2x^2 - x + 1)
+julia> Plotly.plot([trace1, trace2])
+```
+    
+## DataFrames and TimeSeries
+```julia
+julia> using DataFrames
+julia> df = readtable("height_vs_weight.csv")
+julia> trace1 = Plotly.line(df, ["xs"=>:height, "ys"=>:weight])
+julia> trace2 = Plotly.scatter(df, ["xs"=>:height, "ys"=>:weight])
+julia> trace3 = Plotly.histogram(df, ["xs"=>:height])
+julia> trace4 = Plotly.box(df, ["ys"=>:weight])
+julia> Plotly.plot([trace1, trace2, trace3, trace4])
+
+julia> using TimeSeries
+julia> d = [date(2012,5,29):date(2013,5,29)]
+julia> t = TimeArray(d, rand(length(d),2), ["foo","bar"])
+julia> trace1 = Plotly.line(t)
+julia> trace2 = Plotly.scatter(t)
+julia> trace3 = Plotly.box(t)
+julia> trace4 = Plotly.histogram(t)
+julia> Plotly.plot([trace1, trace2, trace3, trace4])
+```
+
+## WAV Files
+```julia
+julia> using WAV
+julia> trace1 = Plotly.line(wavread("filename.wav"))
+julia> trace2 = Plotly.histogram(wavread("filename.wav"))
+julia> trace3 = Plotly.box(wavread("filename.wav"))
+julia> trace4 = Plotly.scatter(wavread("filename.wav"))
+julia> Plotly.plot([trace1, trace2, trace3, trace4])
+```

src/Plotly.jl

@@ -13,9 +13,9 @@ type CurrentPlot
     url::String
 end
 
-default_options = ["filename"=>"Plot from Julia API",
+default_options = {"filename"=>"Plot from Julia API",
 "world_readable"=> true,
-"layout"=>[""=>""]]
+"layout"=>{""=>""}}
 
 ## Taken from https://github.com/johnmyleswhite/Vega.jl/blob/master/src/Vega.jl#L51
 # Open a URL in a browser
@@ -25,16 +25,16 @@ function openurl(url::String)
     @linux_only run(`xdg-open $url`)
 end
 
-default_opts = [ 
+default_opts = {
 "origin" => "plot",
 "platform" => "Julia",
-"version" => "0.2"]
+"version" => "0.2"}
 
 function signup(username::String, email::String)
     r = HTTPClient.HTTPC.post("http://plot.ly/apimkacct", 
     merge(default_opts, 
-    ["un" => username, 
-    "email" => email]))
+    {"un" => username, 
+    "email" => email}))
     if r.http_code == 200
         results = JSON.parse(bytestring(r.body)) 
         for flag in ["error","warning","message"]
@@ -63,10 +63,10 @@ function plot(data::Array,options=Dict())
     opt = merge(default_options,options)
     r = HTTPClient.HTTPC.post("http://plot.ly/clientresp", 
     merge(default_opts,
-    ["un" => plotlyaccount.username,
+    {"un" => plotlyaccount.username,
     "key" => plotlyaccount.api_key,
     "args" => json(data),
-    "kwargs" => json(opt)]))
+    "kwargs" => json(opt)}))
     body=JSON.parse(bytestring(r.body))
     if r.http_code != 200
         error(["r.http_code"])
@@ -92,11 +92,11 @@ function layout(layout_opts::Dict,meta_opts=Dict())
 
     r = HTTPClient.HTTPC.post("http://plot.ly/clientresp",
     merge(default_opts,
-    ["un" => plotlyaccount.username,
+    {"un" => plotlyaccount.username,
     "key" => plotlyaccount.api_key,
     "args" => json(layout_opts),
     "origin" => "layout",
-    "kwargs" => json(meta_opts)]))
+    "kwargs" => json(meta_opts)}))
     __parseresponse(r)
 end
 
@@ -111,11 +111,11 @@ function style(style_opts,meta_opts=Dict())
 
     r = HTTPClient.HTTPC.post("http://plot.ly/clientresp",
     merge(default_opts,
-    ["un" => plotlyaccount.username,
+    {"un" => plotlyaccount.username,
     "key" => plotlyaccount.api_key,
     "args" => json([style_opts]),
     "origin" => "style",
-    "kwargs" => json(meta_opts)]))
+    "kwargs" => json(meta_opts)}))
     __parseresponse(r)
 end
 
@@ -148,9 +148,9 @@ end
 
 function get_template(format_type::String)
     if format_type == "layout" 
-        return [
+        return {
                 "title"=>"Click to enter Plot title",
-                "xaxis"=>[
+                "xaxis"=>{
                         "range"=>[-1,6],
                         "type"=>"-",
                         "mirror"=>true,
@@ -177,9 +177,9 @@ function get_template(format_type::String)
                         "zerolinewidth"=>1, 
                         "title"=>"Click to enter X axis title",
                         "unit"=>"", 
-                        "titlefont"=>["family"=>"","size"=>0,"color"=>""], 
-                        "tickfont"=>["family"=>"","size"=>0,"color"=>""]], 
-                "yaxis"=>[
+                        "titlefont"=>{"family"=>"","size"=>0,"color"=>""}, 
+                        "tickfont"=>{"family"=>"","size"=>0,"color"=>""}}, 
+                "yaxis"=>{
                         "range"=>[-1,4],
                         "type"=>"-",
                         "mirror"=>true,
@@ -206,18 +206,18 @@ function get_template(format_type::String)
                         "zerolinewidth"=>1, 
                         "title"=>"Click to enter Y axis title",
                         "unit"=>"", 
-                        "titlefont"=>["family"=>"","size"=>0,"color"=>""], 
-                        "tickfont"=>["family"=>"","size"=>0,"color"=>""]], 
-                "legend"=>[
+                        "titlefont"=>{"family"=>"","size"=>0,"color"=>""}, 
+                        "tickfont"=>{"family"=>"","size"=>0,"color"=>""}}, 
+                "legend"=>{
                         "bgcolor"=>"#fff", 
                         "bordercolor"=>"#000", 
                         "borderwidth"=>1, 
-                        "font"=>["family"=>"","size"=>0,"color"=>""], 
-                        "traceorder"=>"normal"],
+                        "font"=>{"family"=>"","size"=>0,"color"=>""}, 
+                        "traceorder"=>"normal"},
                 "width"=>700,
                 "height"=>450,
                 "autosize"=>"initial", 
-                "margin"=>["l"=>80,"r"=>80,"t"=>80,"b"=>80,"pad"=>2],
+                "margin"=>{"l"=>80,"r"=>80,"t"=>80,"b"=>80,"pad"=>2},
                 "paper_bgcolor"=>"#fff",
                 "plot_bgcolor"=>"#fff",
                 "barmode"=>"stack",
@@ -226,10 +226,10 @@ function get_template(format_type::String)
                 "boxmode"=>"overlay",
                 "boxgap"=>0.3,
                 "boxgroupgap"=>0.3,
-                "font"=>["family"=>"Arial, sans-serif;","size"=>12,"color"=>"#000"],
-                "titlefont"=>["family"=>"","size"=>0,"color"=>""],
+                "font"=>{"family"=>"Arial, sans-serif;","size"=>12,"color"=>"#000"},
+                "titlefont"=>{"family"=>"","size"=>0,"color"=>""},
                 "dragmode"=>"zoom",
-                "hovermode"=>"x"]
+                "hovermode"=>"x"}
     end
 end