improve user manual - docs

Author: sl-solution

docs/assets/ohlc.csv

@@ -0,0 +1,45 @@
+close,date,high,low,open,ret,signal,c
+30.04,2009-06-01,30.05,28.45,28.7,-4.89396411092985,short,green
+29.63,2009-06-02,30.13,28.3,30.04,-0.322580645161295,short,red
+31.02,2009-06-03,31.79,29.62,29.62,3.68663594470045,short,green
+30.18,2009-06-04,31.02,29.92,31.02,4.51010886469673,short,red
+29.62,2009-06-05,30.81,28.85,29.39,6.08424336973478,short,green
+29.77,2009-06-08,31.82,26.41,30.84,1.2539184952978,short,red
+28.27,2009-06-09,29.77,27.79,29.77,-5.02431118314424,short,red
+28.46,2009-06-10,29.74,26.9,26.9,-5.46623794212217,short,green
+28.11,2009-06-11,28.11,26.81,27.36,-8.3743842364532,short,green
+28.15,2009-06-12,28.5,27.73,28.08,-5.52763819095477,short,green
+30.81,2009-06-15,31.09,29.64,29.7,3.4920634920635,long,green
+32.68,2009-06-16,32.75,30.07,30.81,0.155038759689914,short,green
+31.54,2009-06-17,32.77,30.64,31.19,5.82822085889571,short,green
+30.03,2009-06-18,31.54,29.6,31.54,8.17610062893082,short,red
+27.99,2009-06-19,29.32,27.56,29.16,8.59872611464968,short,red
+31.17,2009-06-22,32.05,30.3,30.4,15.4907975460123,short,green
+30.58,2009-06-23,31.54,27.83,31.3,11.7370892018779,short,red
+29.05,2009-06-24,30.58,28.79,30.58,-10.4234527687296,long,red
+26.36,2009-06-25,29.56,26.3,29.45,0.0,long,red
+25.93,2009-06-26,27.22,25.76,27.09,0.0,long,red
+25.35,2009-06-29,27.18,25.29,25.93,5.26315789473684,long,red
+26.35,2009-06-30,27.38,25.02,25.36,6.73758865248228,long,green
+26.22,2009-07-01,26.31,24.8,25.73,7.83645655877341,long,green
+27.95,2009-07-02,28.62,26.22,26.22,2.76422764227643,long,green
+29.0,2009-07-06,30.6,28.99,30.32,-2.14521452145214,short,red
+30.85,2009-07-07,30.94,28.9,29.0,3.03514376996805,short,green
+31.3,2009-07-08,33.05,30.43,30.85,5.68720379146919,short,green
+29.78,2009-07-09,30.49,29.28,30.23,8.22784810126583,short,red
+29.02,2009-07-10,30.34,28.82,29.78,8.64779874213836,short,red
+26.31,2009-07-13,29.24,25.42,28.36,7.32899022801303,short,red
+25.02,2009-07-14,26.84,24.99,26.31,7.30897009966778,short,red
+25.89,2009-07-15,26.06,23.83,25.05,0.0,neutral,green
+25.42,2009-07-16,26.18,24.51,25.96,-9.82758620689656,long,red
+24.34,2009-07-17,25.55,23.88,25.42,-10.8433734939759,long,red
+24.4,2009-07-20,25.42,24.26,25.06,-7.55711775043936,long,red
+23.87,2009-07-21,25.14,23.81,24.28,-2.5089605734767,long,red
+23.47,2009-07-22,24.14,23.24,24.05,0.915750915750916,long,red
+23.43,2009-07-23,24.05,23.21,23.71,2.47148288973383,long,red
+23.09,2009-07-24,23.87,23.0,23.87,4.22264875239922,long,red
+24.28,2009-07-27,24.86,24.02,24.06,-0.189393939393929,long,green
+25.01,2009-07-28,25.61,24.28,24.28,-4.37956204379562,long,green
+25.61,2009-07-29,26.18,25.41,25.47,-4.48504983388705,long,green
+25.4,2009-07-30,25.76,24.85,25.4,-1.70357751277683,long,red
+25.92,2009-07-31,26.22,24.93,25.4,5.06756756756757,short,green

docs/gallery/Plots/BoxPlot/boxplot.jl

@@ -78,4 +78,25 @@ sgplot(ds, BoxPlot(y=1:10, category=:Category,
                       yaxis=Axis(show=false),
                       legend=false,
                       clip=false
-                      )
+                      )
+
+# Application - Dubai weather
+dubai_weather = filereader(joinpath(dirname(pathof(StatisticalGraphics)),
+                                 "..", "docs", "assets", "dubai_weather.csv"),
+                                 types=Dict(1 =>Date))
+
+modify!(dubai_weather, :date=>byrow(week)=>:Week)
+setformat!(dubai_weather, :date=>month)
+
+sgplot(
+        dubai_weather,
+        [
+          BoxPlot(y=[:min, :max], category=:date, outliers=true),
+          BoxPlot(y=:pressure, category=:Week, opacity=0.5, y2axis=true, outliers=true, x2axis=true)
+        ],
+        xaxis=Axis(title="Month"),
+        yaxis=Axis(title="Temperature"),
+        y2axis=Axis(title="Pressure", d3format="f"),
+        x2axis=Axis(values=3:4:53),
+        height=600
+      )

docs/gallery/Plots/Line/line3.jl

@@ -23,6 +23,22 @@ sgplot(dubai_weather, Line(x=:date, y=:pressure, breaks=true), xaxis=Axis(type=:
 
 sgplot(dubai_weather, [Line(x=:date, y=:pressure, breaks=true), Scatter(x=:date, y=:pressure)], xaxis=Axis(type=:date))
 
+# multiple axes
+
+sgplot(
+        dubai_weather,
+        [
+          Band(x=:date, lower=:min, upper=:max),
+          Line(x=:date, y=:min, color="#4682b4", thickness=1),
+          Line(x=:date, y=:max, color="#ff7f0e", thickness=0.5),
+          Line(x=:date, y=:pressure, color="#2ca02c", y2axis=true, breaks=true),
+          Scatter(x=:date, y=:pressure, outlinecolor="#2ca02c", size=10, y2axis=true)
+        ],
+        xaxis=Axis(offset=10, type=:date, grid=true, griddash=[1, 1], title="Date"),
+        yaxis=Axis(offset=10, grid=true, griddash=[1, 1], title="Temperature(°C)"),
+        y2axis=Axis(offset=10, title="Pressure")
+)
+
 # The `interpolate` keyword argument can be used to intepolate line,
 
 ds = Dataset(x=1:10, y=rand(10))
@@ -36,7 +52,7 @@ color=Dict( :linear=>:blue,
 sgplot(ds, [
             [
               Line(x=:x, y=:y, interpolate=v, thickness=2, color=color[v])
-              for v in [:linear, :basis, :step, :natural]
+              for v in keys(color)
             ]; Scatter(x=:x, y=:y, color=:steelblue, size=100)
             ],
             clip=false

docs/gallery/Plots/Pie/pie.jl

@@ -0,0 +1,50 @@
+# ---
+# title: Pie chart
+# id: demo_pie
+# description: Using the `Pie` mark to produce Pie charts
+# cover: assets/pie_1.svg
+# ---
+
+using InMemoryDatasets, StatisticalGraphics, DLMReader
+
+svg("assets/pie_1.svg", sgplot(Dataset(x=1:4, y=[1,1,1.5,2]), Pie(category=:x, response=:y), width=150, height=100, legend=false)) #hide #md
+
+# Pie chart shows the frequency of `category` in a data set as proportional slices of a whole circle
+
+sgplot(Dataset(x=[1,2,3,3,4,4,4]),
+             Pie(category=:x)
+       )
+
+# Users can pass a column as response for computing the slices based on the aggregated values of the passed column. The `stat` keyword argument is used to aggregate the values.
+
+cars = filereader(joinpath(dirname(pathof(StatisticalGraphics)),
+                                 "..", "docs", "assets", "cars.csv"),
+                                 types=Dict(9=>Date))
+
+
+sgplot(cars,
+            Pie(category=:Origin, response=:Acceleration, stat=IMD.mean)
+        )
+
+# A column can be passed as `group` to produce a nested pie chart
+
+sgplot(cars,
+            
+            Pie(category=:Cylinders,
+                group=:Origin,
+                groupspace=0.05,
+                )
+    )
+
+# The donut chart is produced by passing `innerradius`
+
+sgplot(cars,
+            Pie(category=:Origin, innerradius=0.4)
+        )
+
+# Slices can be labeled based on their frequency and/or category
+
+
+sgplot(cars,
+            Pie(category=:Origin, label=:both)
+        )

docs/gallery/Plots/Pie/pie2.jl

@@ -0,0 +1,84 @@
+# ---
+# title: Other features
+# id: demo_pie2
+# description: Customising Pie charts
+# cover: assets/pie_2.svg
+# ---
+
+using InMemoryDatasets, StatisticalGraphics, DLMReader
+
+svg("assets/pie_2.svg", sgplot( Dataset(x=[0.6, 0.4], done=["60%", missing]),[Pie(category=:x, response=:x,innerradius=0.7,startangle=-110,endangle=110,outlinecolor=:black,colormodel=[:steelblue, :transparent]),Pie(category=:done,opacity=0,label=:category,labelpos=0,labelangle=0,labelsize=20,labelcolor=:gray)],legend=false,clip=false,width=150, height=100,)) #hide #md
+
+
+# Create gauge with changing the values of start/end angles
+
+ds = Dataset(x=[0.6, 0.4], done=["60%", missing])
+sgplot(ds,
+    [
+        Pie(category=:x, response=:x,
+            innerradius=0.7,
+            startangle=-110,
+            endangle=110,
+            outlinecolor=:black,
+            colormodel=[:steelblue, :transparent]
+        ),
+        Pie(category=:done,
+            opacity=0,
+            label=:category,
+            labelpos=0,
+            labelangle=0,
+            labelsize=100,
+            labelcolor=:gray
+        )
+    ],
+    legend=false
+        
+)
+
+# Controlling the color model
+
+ds = Dataset(x=1:39, y=[rand(1:39, 30) for _ in 1:39])
+flatten!(ds, :y)
+insertcols!(ds, :z=>rand(nrow(ds)))
+
+sgplot(ds, 
+        Pie(category=:x, group=:y,
+            response=:z,
+            groupspace=0,
+            innerradius=0.1,
+            piecorner=10,
+            colormodel=[:black, :white]),
+        legend=false,
+    )
+
+# Nested Pie chart
+
+cars = filereader(joinpath(dirname(pathof(StatisticalGraphics)),
+                                 "..", "docs", "assets", "cars.csv"),
+                                 types=Dict(9=>Date))
+
+sgplot(cars,
+           [
+            Pie(category=:Cylinders,
+                group=:Origin,
+                groupspace=0.05,
+                innerradius=0.1,
+                label=:category,
+                labelangle=0,
+                piecorner=5
+            ),
+            Pie(category=:Origin,
+                group=:Origin,
+                innerradius=0.1,
+                opacity=0,
+                endangle=0.1,
+                groupspace=0.05,
+                label=:category,
+                labelpos=1,
+                labelbaseline=:bottom,
+                labelsize=8
+            )
+           ],
+    legend=false,
+    clip=false     
+)

docs/gallery/Plots/Segment/segment.jl

@@ -0,0 +1,64 @@
+# ---
+# title: Line segments
+# id: demo_segment
+# description: Using the `Segment` mark to produce line segments
+# cover: assets/segment_1.svg
+# ---
+
+using InMemoryDatasets, StatisticalGraphics, DLMReader
+
+svg("assets/segment_1.svg", sgplot(Dataset(y=1:1:4, low=rand(4), up=rand(4) .+ 1.3), [Segment(y=:y, lower=:low, upper=:up), Scatter(y=:y, x=:low, symbol=:stroke, angle=90), Scatter(y=:y, x=:up, symbol=:stroke, angle=90), RefLine(values=1, axis=:xaxis, dash=[2])], width=100, height=100, xaxis=Axis(offset=0, domain=true,labelcolor=:black, tickcolor=:black,titlecolor=:white, padding=10), yaxis=Axis(offset=0,domain=true,labelcolor=:black, tickcolor=:black,titlecolor=:white, tickcount=5, padding =10), legend=false, clip=false)) #hide #md
+
+# `Segment` produces line segments. For each segment the main coordinate and the lower and the upper value must be supplied.
+
+ds = Dataset(y=1:10, low=rand(10), up=rand(10) .+ 1.3)
+sgplot(ds,
+        Segment(y=:y, lower=:low, upper=:up),
+        clip=false
+      )
+
+
+
+# Overlay Scatter plot
+
+cars = filereader(joinpath(dirname(pathof(StatisticalGraphics)),
+                                 "..", "docs", "assets", "cars.csv"),
+                                 types=Dict(9=>Date))
+cars_sum = combine(groupby(cars, :Origin), 1=>[IMD.mean, IMD.maximum, IMD.minimum])
+
+sgplot(cars_sum,
+                [
+                    Segment(y=:Origin, lower=r"^min", upper=r"^max"),
+                    Scatter(y=:Origin, x=r"^mean"),
+                    Scatter(y=:Origin, x=r"^min", symbol=:stroke, angle=90),
+                    Scatter(y=:Origin, x=r"^max", symbol=:stroke, angle=90)
+                ],
+                xaxis=Axis(title="Acceleration", padding=10),
+                yaxis=Axis(padding=.5)
+        )
+
+# `Segment` like other plots accept `group`.
+
+ohlc = filereader(joinpath(dirname(pathof(StatisticalGraphics)),
+                                 "..", "docs", "assets", "ohlc.csv"),
+                                 types = Dict(2=>Date, 8=>Symbol))
+
+sgplot(ohlc,
+        Segment(x=:date, lower=:low, upper=:high, group=:c),
+        groupcolormodel=ohlc[:, :c],
+        xaxis=Axis(type=:time),
+        yaxis=Axis(title="")
+      )
+
+# Candlestick Chart
+
+sgplot(ohlc,
+        [
+            Segment(x=:date, lower=:open, upper=:close, group=:c, thickness=5),
+            Segment(x=:date, lower=:low, upper=:high, group=:c)           
+        ],
+        groupcolormodel=ohlc[:, :c],
+        xaxis=Axis(type=:time),
+        yaxis=Axis(title=""),
+        legend=false
+      )

docs/gallery/Plots/config.json

@@ -1,9 +1,3 @@
 {
-    "theme": "list",
-    "order":[
-        "Line",
-        "Scatter",
-        "BoxPlot",
-        "Bar"
-    ]
+    "theme": "list"
 }