plotDFG replaces dfgplot

Author: dehann

NEWS.md

@@ -8,6 +8,7 @@ Listing news on any major breaking changes in DFG.  For regular changes, see int
 - Towards distributions serialized via JSON, getting away from custom strings.
 - `LocalDFG` replaces `DefaultDFG` (#844).
 - Optimized creation of CGDFG / `createDfgSessionIfNotExist` (#839, #815).
+- `plotDFG` replaces `dfgplot` (#841, #844).
 
 # v0.16.0
 

attic/MetaGraphsDFG/DFGPlots.jl

@@ -9,15 +9,15 @@ using GraphPlot
 using DistributedFactorGraphs, DistributedFactorGraphs.DFGPlots
 # ... Make graph...
 # Using GraphViz plotting
-dfgplot(fg)
+plotDFG(fg)
 # Save to PDFG
 using Compose
-draw(PDF("/tmp/graph.pdf", 16cm, 16cm), dfgplot(fg))
+draw(PDF("/tmp/graph.pdf", 16cm, 16cm), plotDFG(fg))
 ```
 
 More information at [GraphPlot.jl](https://github.com/JuliaGraphs/GraphPlot.jl)
 """
-function dfgplot(dfg::DistributedFactorGraphs.MetaGraphsDFG, p::DFGPlotProps = DFGPlotProps())
+function plotDFG(dfg::DistributedFactorGraphs.MetaGraphsDFG, p::DFGPlotProps = DFGPlotProps())
     @info "Deprecated, please use GraphsDFG or LightDFG."
     nodesize = [has_prop(dfg.g,i,:factor) ?  p.nodesize.fac : p.nodesize.var for i=vertices(dfg.g)]
     if p.drawlabels

docs/src/DrawingGraphs.md

@@ -18,7 +18,7 @@ using GraphPlot
 using DistributedFactorGraphs
 ```
 
-Any factor graph can then be drawn by calling [`dfgplot`](@ref):
+Any factor graph can then be drawn by calling [`plotDFG`](@ref):
 
 ```@example plots
 using Cairo # hide
@@ -35,7 +35,7 @@ f1 = addFactor!(dfg, [:l0; :x0], LinearConditional(Normal(40.0,5.0)), solvable=1
 f1 = addFactor!(dfg, [:l0; :x1], LinearConditional(Normal(-10.0,5.0)), solvable=1)
 
 # Plot graph
-dfgplot(dfg)
+plotDFG(dfg)
 ```
 
 ### Rendering GraphPlot to PDF
@@ -49,7 +49,7 @@ dfg.solverParams.graphinit = false # hide
 addVariable!(dfg, :x2, ContinuousScalar);
 addFactor!(dfg, [:x1; :x2], LinearConditional(Normal(50.0,2.0)));
 # Save to SVG
-draw(SVG("graph.svg", 10cm, 10cm), dfgplot(dfg));
+draw(SVG("graph.svg", 10cm, 10cm), plotDFG(dfg));
 nothing # hide
 ```
 ![](graph.svg)

src/DFGPlots/DFGPlots.jl

@@ -9,7 +9,7 @@ import ..GraphPlot: gplot
 using ...DistributedFactorGraphs
 
 export
-    dfgplot,
+    plotDFG,
     DFGPlotProps
 
 struct DFGPlotProps
@@ -40,15 +40,15 @@ using GraphPlot
 using DistributedFactorGraphs, DistributedFactorGraphs.DFGPlots
 # ... Make graph...
 # Using GraphViz plotting
-dfgplot(fg)
+plotDFG(fg)
 # Save to PDF
 using Compose
-draw(PDF("/tmp/graph.pdf", 16cm, 16cm), dfgplot(fg))
+draw(PDF("/tmp/graph.pdf", 16cm, 16cm), plotDFG(fg))
 ```
 
 More information at [GraphPlot.jl](https://github.com/JuliaGraphs/GraphPlot.jl)
 """
-function dfgplot(dfg::GraphsDFG, p::DFGPlotProps = DFGPlotProps())
+function plotDFG(dfg::GraphsDFG, p::DFGPlotProps = DFGPlotProps())
 
     nodetypes = [haskey(dfg.g.variables, s) for s in dfg.g.labels]
 
@@ -66,11 +66,11 @@ function dfgplot(dfg::GraphsDFG, p::DFGPlotProps = DFGPlotProps())
 
 end
 
-function dfgplot(dfg::AbstractDFG, p::DFGPlotProps = DFGPlotProps())
+function plotDFG(dfg::AbstractDFG, p::DFGPlotProps = DFGPlotProps())
     # TODO implement convert functions
     ldfg = GraphsDFG{NoSolverParams}()
     copyGraph!(ldfg, dfg, listVariables(dfg), listFactors(dfg), copyGraphMetadata=false)
-    dfgplot(ldfg, p)
+    plotDFG(ldfg, p)
 end
 
 function gplot(dfg::GraphsDFG; keyargs...)
@@ -79,14 +79,14 @@ end
 
 #TODO decide if we want to overload show for display in juno, It's a bit annoying with development
 # function Base.show(io::IO, ::MIME"application/prs.juno.plotpane+html", dfg::AbstractDFG)
-function dfgplot(io::IO, ::MIME"application/prs.juno.plotpane+html", dfg::AbstractDFG)
+function plotDFG(io::IO, ::MIME"application/prs.juno.plotpane+html", dfg::AbstractDFG)
 
     if length(ls(dfg)) != 0
         size = get(io, :juno_plotsize, [100, 100])
 
         plot_output = IOBuffer()
         GraphPlot.draw(GraphPlot.SVGJS(plot_output, GraphPlot.Compose.default_graphic_width,
-                   GraphPlot.Compose.default_graphic_width, false), dfgplot(dfg))
+                   GraphPlot.Compose.default_graphic_width, false), plotDFG(dfg))
         plotsvg = String(take!(plot_output))
 
         print(io,

test/attic/IIF4DoorsTests.jl

@@ -67,7 +67,7 @@ mlc = MixturePrior(Normal.(doors[1,:], bws[1]), 0.25*ones(4))
 addFactor!(fg,[:x7], mlc )
 
 
-dfgplot(fg)
+plotDFG(fg)
 
 tree = solveTree!(fg)
 

test/plottingTest.jl

@@ -19,15 +19,15 @@ map(n -> addFactor!(dfg, DFGFactor{TestFunctorInferenceType1}(Symbol("x$(n)x$(n+
 ##
 
 # Using GraphPlot plotting
-plot = dfgplot(dfg)
+plot = plotDFG(dfg)
 @test plot !== nothing
 
 ##
 
 #TODO test something more
 #NOTE just running function to see if it plots
 iobuf = IOBuffer()
-dfgplot(iobuf, MIME("application/prs.juno.plotpane+html"), dfg)
+plotDFG(iobuf, MIME("application/prs.juno.plotpane+html"), dfg)
 @test length(take!(iobuf)) > 1e3
 
 ##

test/testBlocks.jl

@@ -1497,7 +1497,7 @@ function CopyFunctionsTest(testDFGAPI; kwargs...)
     @test issetequal(ls(dcdfg_part), vlbls)
     @test issetequal(lsf(dcdfg_part), flbls)
     @test !isConnected(dcdfg_part)
-    # dfgplot(dcdfg_part)
+    # plotDFG(dcdfg_part)
 
 
     vlbls = [:x2, :x3]