update arg syntax for gplot: (address JuliaGraphs#177)

-breaking change: linetype changed from String to Symbol -breaking change: default for edgelabel is nothing (not []) to make consistent with nodelabel default -remove all caps args -improve some of the code in gplot (use isnothing, etc.)
hdavid16 · Jul 27, 2022 · d610f15 · d610f15
1 parent 14d62b4
commit d610f15
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 59 deletions.
diff --git a/README.md b/README.md
@@ -129,7 +129,7 @@ gplot(g, locs_x, locs_y, nodelabel=nodelabel)
 
 ## Curve edge
 ```julia
-gplot(g, linetype="curve")
+gplot(g, linetype=:curve)
 ```
 
 ## Show plot
@@ -160,28 +160,28 @@ gplot(h)
 
 # Keyword Arguments
 + `layout` Layout algorithm: `random_layout`, `circular_layout`, `spring_layout`, `shell_layout`, `stressmajorize_layout`, `spectral_layout`. Default: `spring_layout`
-+ `NODESIZE` Max size for the nodes. Default: `3.0/sqrt(N)`
++ `max_nodesize` Max size for the nodes. Default: `3.0/sqrt(N)`
 + `nodesize` Relative size for the nodes, can be a Vector. Default: `1.0`
 + `nodelabel` Labels for the vertices, a Vector or nothing. Default: `nothing`
 + `nodelabelc` Color for the node labels, can be a Vector. Default: `colorant"black"`
 + `nodelabeldist` Distances for the node labels from center of nodes. Default: `0.0`
 + `nodelabelangleoffset` Angle offset for the node labels. Default: `π/4.0`
-+ `NODELABELSIZE` Largest fontsize for the vertice labels. Default: `4.0`
++ `max_nodelabelsize` Largest fontsize for the vertice labels. Default: `4.0`
 + `nodelabelsize` Relative fontsize for the vertice labels, can be a Vector. Default: `1.0`
 + `nodefillc` Color to fill the nodes with, can be a Vector. Default: `colorant"turquoise"`
 + `nodestrokec` Color for the nodes stroke, can be a Vector. Default: `nothing`
 + `nodestrokelw` Line width for the nodes stroke, can be a Vector. Default: `0.0`
-+ `edgelabel` Labels for the edges, a Vector or nothing. Default: `[]`
++ `edgelabel` Labels for the edges, a Vector or nothing. Default: `nothing`
 + `edgelabelc` Color for the edge labels, can be a Vector. Default: `colorant"black"`
 + `edgelabeldistx, edgelabeldisty` Distance for the edge label from center of edge. Default: `0.0`
-+ `EDGELABELSIZE` Largest fontsize for the edge labels. Default: `4.0`
++ `max_edgelabelsize` Largest fontsize for the edge labels. Default: `4.0`
 + `edgelabelsize` Relative fontsize for the edge labels, can be a Vector. Default: `1.0`
-+ `EDGELINEWIDTH` Max line width for the edges. Default: `0.25/sqrt(N)`
++ `max_edgelinewidth` Max line width for the edges. Default: `0.25/sqrt(N)`
 + `edgelinewidth` Relative line width for the edges, can be a Vector. Default: `1.0`
 + `edgestrokec` Color for the edge strokes, can be a Vector. Default: `colorant"lightgray"`
 + `arrowlengthfrac` Fraction of line length to use for arrows. Equal to 0 for undirected graphs. Default: `0.1` for the directed graphs
 + `arrowangleoffset` Angular width in radians for the arrows. Default: `π/9 (20 degrees)`
-+ `linetype` Type of line used for edges ("straight", "curve"). Default: "straight"
++ `linetype` Type of line used for edges (:straight, :curve). Default: :straight
 + `outangle` Angular width in radians for the edges (only used if `linetype = "curve`). Default: `π/5 (36 degrees)`
 + `backgroundc` Color for the plot background. Default: `nothing`
 

diff --git a/src/plot.jl b/src/plot.jl
@@ -23,7 +23,7 @@ Layout algorithm. Currently can be one of [`random_layout`,
 `spectral_layout`].
 Default: `spring_layout`
 
-`NODESIZE`
+`max_nodesize`
 Max size for the nodes. Default: `3.0/sqrt(N)`
 
 `nodesize`
@@ -41,7 +41,7 @@ Distances for the node labels from center of nodes. Default: `0.0`
 `nodelabelangleoffset`
 Angle offset for the node labels. Default: `π/4.0`
 
-`NODELABELSIZE`
+`max_nodelabelsize`
 Largest fontsize for the vertex labels. Default: `4.0`
 
 `nodelabelsize`
@@ -57,21 +57,21 @@ Color for the nodes stroke, can be a Vector. Default: `nothing`
 Line width for the nodes stroke, can be a Vector. Default: `0.0`
 
 `edgelabel`
-Labels for the edges, a Vector or nothing. Default: `[]`
+Labels for the edges, a Vector or nothing. Default: `nothing`
 
 `edgelabelc`
 Color for the edge labels, can be a Vector. Default: `colorant"black"`
 
 `edgelabeldistx, edgelabeldisty`
 Distance for the edge label from center of edge. Default: `0.0`
 
-`EDGELABELSIZE`
+`max_edgelabelsize`
 Largest fontsize for the edge labels. Default: `4.0`
 
 `edgelabelsize`
 Relative fontsize for the edge labels, can be a Vector. Default: `1.0`
 
-`EDGELINEWIDTH`
+`max_edgelinewidth`
 Max line width for the edges. Default: `0.25/sqrt(N)`
 
 `edgelinewidth`
@@ -88,7 +88,7 @@ Equal to 0 for undirected graphs. Default: `0.1` for the directed graphs
 Angular width in radians for the arrows. Default: `π/9 (20 degrees)`
 
 `linetype`
-Type of line used for edges ("straight", "curve"). Default: "straight"
+Type of line used for edges (:straight, :curve). Default: :straight
 
 `outangle`
 Angular width in radians for the edges (only used if `linetype = "curve`). 
@@ -103,38 +103,32 @@ function gplot(g::AbstractGraph{T},
     nodelabel = nothing,
     nodelabelc = colorant"black",
     nodelabelsize = 1.0,
-    NODELABELSIZE = 4.0,
+    max_nodelabelsize = 4.0,
     nodelabeldist = 0.0,
     nodelabelangleoffset = π / 4.0,
-    edgelabel = [],
+    edgelabel = nothing,
     edgelabelc = colorant"black",
     edgelabelsize = 1.0,
-    EDGELABELSIZE = 4.0,
+    max_edgelabelsize = 4.0,
     edgestrokec = colorant"lightgray",
     edgelinewidth = 1.0,
-    EDGELINEWIDTH = 3.0 / sqrt(nv(g)),
+    max_edgelinewidth = 3.0 / sqrt(nv(g)),
     edgelabeldistx = 0.0,
     edgelabeldisty = 0.0,
     nodesize = 1.0,
-    NODESIZE = 0.25 / sqrt(nv(g)),
+    max_nodesize = 0.25 / sqrt(nv(g)),
     nodefillc = colorant"turquoise",
     nodestrokec = nothing,
     nodestrokelw = 0.0,
     arrowlengthfrac = is_directed(g) ? 0.1 : 0.0,
     arrowangleoffset = π / 9,
-    linetype = "straight",
+    linetype = :straight,
     outangle = π / 5,
     backgroundc = nothing) where {T <:Integer, R1 <: Real, R2 <: Real}
 
-    length(locs_x_in) != length(locs_y_in) && error("Vectors must be same length")
-    N = nv(g)
-    NE = ne(g)
-    if nodelabel != nothing && length(nodelabel) != N
-        error("Must have one label per node (or none)")
-    end
-    if !isempty(edgelabel) && length(edgelabel) != NE
-        error("Must have one label per edge (or none)")
-    end
+    @assert length(locs_x_in) == length(locs_y_in) == nv(g) "Position vectors must be of the same length as the number of nodes"
+    @assert isnothing(nodelabel) || length(nodelabel) == nv(g) "`nodelabel` must either be `nothing` or a vector of the same length as the number of nodes"
+    @assert isnothing(edgelabel) || length(edgelabel) == ne(g) "`edgelabel` must either be `nothing` or a vector of the same length as the number of edges"
 
     locs_x = Float64.(locs_x_in)
     locs_y = Float64.(locs_y_in)
@@ -152,35 +146,18 @@ function gplot(g::AbstractGraph{T},
     map!(z -> scaler(z, min_x, max_x), locs_x, locs_x)
     map!(z -> scaler(z, min_y, max_y), locs_y, locs_y)
 
-    # Determine sizes
-    #NODESIZE    = 0.25/sqrt(N)
-    #LINEWIDTH   = 3.0/sqrt(N)
-
-    max_nodesize = NODESIZE / maximum(nodesize)
-    nodesize *= max_nodesize
-    max_edgelinewidth = EDGELINEWIDTH / maximum(edgelinewidth)
-    edgelinewidth *= max_edgelinewidth
-    max_edgelabelsize = EDGELABELSIZE / maximum(edgelabelsize)
-    edgelabelsize *= max_edgelabelsize
-    max_nodelabelsize = NODELABELSIZE / maximum(nodelabelsize)
-    nodelabelsize *= max_nodelabelsize
+    # Scale sizes
+    nodesize *= (max_nodesize / maximum(nodesize))
+    edgelinewidth *= (max_edgelinewidth / maximum(edgelinewidth))
+    edgelabelsize *= (max_edgelabelsize / maximum(edgelabelsize))
+    nodelabelsize *= (max_nodelabelsize / maximum(nodelabelsize))
     max_nodestrokelw = maximum(nodestrokelw)
     if max_nodestrokelw > 0.0
-        max_nodestrokelw = EDGELINEWIDTH / max_nodestrokelw
-        nodestrokelw *= max_nodestrokelw
+        nodestrokelw *= (max_edgelinewidth / max_nodestrokelw)
     end
 
     # Create nodes
-    nodecircle = fill(0.4Compose.w, length(locs_x))
-    if isa(nodesize, Real)
-        for i = 1:length(locs_x)
-            nodecircle[i] *= nodesize
-        end
-    else
-        for i = 1:length(locs_x)
-            nodecircle[i] *= nodesize[i]
-        end
-    end
+    nodecircle = fill(0.4Compose.w, nv(g)) .* nodesize
     nodes = circle(locs_x, locs_y, nodecircle)
 
     # Create node labels if provided
@@ -194,24 +171,23 @@ function gplot(g::AbstractGraph{T},
     end
     # Create edge labels if provided
     edgetexts = nothing
-    if !isempty(edgelabel)
+    if !isnothing(edgelabel)
         edge_locs_x = zeros(R, NE)
         edge_locs_y = zeros(R, NE)
         for (e_idx, e) in enumerate(edges(g))
             i = src(e)
             j = dst(e)
             mid_x = (locs_x[i]+locs_x[j]) / 2.0
             mid_y = (locs_y[i]+locs_y[j]) / 2.0
-            edge_locs_x[e_idx] = (is_directed(g) ? (mid_x+locs_x[j]) / 2.0 : mid_x) + edgelabeldistx * NODESIZE
-            edge_locs_y[e_idx] = (is_directed(g) ? (mid_y+locs_y[j]) / 2.0 : mid_y) + edgelabeldisty * NODESIZE
-
+            edge_locs_x[e_idx] = (is_directed(g) ? (mid_x+locs_x[j]) / 2.0 : mid_x) + edgelabeldistx * max_nodesize
+            edge_locs_y[e_idx] = (is_directed(g) ? (mid_y+locs_y[j]) / 2.0 : mid_y) + edgelabeldisty * max_nodesize
         end
         edgetexts = text(edge_locs_x, edge_locs_y, map(string, edgelabel), [hcenter], [vcenter])
     end
 
     # Create lines and arrow heads
     lines, arrows = nothing, nothing
-    if linetype == "curve"
+    if linetype == :curve
         if arrowlengthfrac > 0.0
             curves_cord, arrows_cord = graphcurve(g, locs_x, locs_y, nodesize, arrowlengthfrac, arrowangleoffset, outangle)
             lines = curve(curves_cord[:,1], curves_cord[:,2], curves_cord[:,3], curves_cord[:,4])

diff --git a/test/runtests.jl b/test/runtests.jl
@@ -93,7 +93,7 @@ end
     add_edge!(g2, 1,2)
     add_edge!(g2, 2,1)
 
-    plot_and_save1(fname) = plot_and_save(fname, g2, linetype="curve")
+    plot_and_save1(fname) = plot_and_save(fname, g2, linetype=:curve)
     refimg1 = joinpath(datadir, "curve.png")
     @test test_images(VisualTest(plot_and_save1, refimg1), popup=!istravis) |> save_comparison |> success
 
@@ -102,7 +102,7 @@ end
     add_edge!(g3, 1,2)
     add_edge!(g3, 2,1)
 
-    plot_and_save2(fname) = plot_and_save(fname, g3, linetype="curve")
+    plot_and_save2(fname) = plot_and_save(fname, g3, linetype=:curve)
     refimg2 = joinpath(datadir, "self_directed.png")
     @test test_images(VisualTest(plot_and_save2, refimg2), popup=!istravis) |> save_comparison |> success