Graph constructors and tests (#2)

* add constructor methods

* rework filenames, add tests, update docs

* more tests, fixes to DiGraph construction

Author: vlandau

.gitignore

@@ -3,3 +3,4 @@ run-dev.sh
 Manifest.toml
 docs/build
 docs/make-local.jl
+local

Project.toml

@@ -12,5 +12,4 @@ Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [compat]
 ArchGDAL = "0.6"
-GeoData = "0.4.6"
 julia = "1.6"

docs/make.jl

@@ -5,7 +5,7 @@ const formats = Any[
     	assets = [
     		"assets/custom.css"
     	],
-	edit_link = :commit,
+	    edit_link = :commit,
     ),
 ]
 
@@ -15,7 +15,8 @@ makedocs(
     authors = "Vincent A. Landau",
     sitename = "SpatialGraphs.jl",
     pages = ["About" => "index.md",
-             "Graph Types" => "graphtypes.md"],
+             "Graph Types" => "graphtypes.md",
+             "User Guide" => "userguide.md"],
 )
 
 deploydocs(

docs/src/graphtypes.md

@@ -15,18 +15,19 @@ AbstractSpatialGraph
 The `AbstractRasterGraph` type is as subtype of `AbstractSpatialGraph`. All
 `AbstractRasterGraph` subtypes contain a field called `vertex_raster`, which is 
 a `GeoData.GeoArray` that describes the spatial locations for the vertices in 
-the graph. If your graph has 10 vertices, then the corresponding `GeoArray` 
+the graph. If your graph has 10 vertices, then the corresponding `vertex_raster` 
 must have 10 unique values, starting at 1 (which corresponds to the first vertex
 in the graph) and going up to 10 (which corresponds to the tenth vertex in the 
 graph). To find the location of a given graph vertex, _n_, you simply identify 
-the pixel(s) with a value of _n_.
+the pixel(s) with a value of _n_. For pixels/elements in `vertex_raster` for
+which there shouldn't be a graph vertex, use a value of 0.
 ```@docs
 AbstractRasterGraph
 ```
 
 ## AbstractRasterGraph Subtypes
 SpatialGraphs.jl has raster graph types for undirected, directed, unweighted,
-and weighted graphsm each detailed below.
+and weighted graphs, each detailed below.
 
 ```@docs
 SimpleRasterGraph

docs/src/userguide.md

@@ -0,0 +1,11 @@
+# User Guide
+
+## Building Graphs from Rasters
+
+SpatialGraphs.jl offers options methods for constructing graphs from raster
+data.
+
+```@docs
+weightedrastergraph
+make_raster_graph
+```

src/SpatialGraphs.jl

@@ -4,8 +4,13 @@ using LightGraphs, SimpleWeightedGraphs, ArchGDAL, GeoData
 
 include("structs.jl")
 include("graph_interface.jl")
+include("rastergraphs.jl")
+include("utils.jl")
 ## Types and Structs
 export AbstractSpatialGraph, AbstractRasterGraph, SimpleRasterGraph,
        SimpleRasterDiGraph, WeightedRasterGraph, WeightedRasterDiGraph
 
+## Raster graph
+export make_raster_graph, weightedrastergraph
+
 end # module

src/graph_interface.jl

@@ -1,5 +1,14 @@
 ## Methods for the LightGraphs ad SimpleWeightedGraphs interfaces
 ## With these methods defined, functions from LightGraphs should "just work"
+import LightGraphs: 
+    nv, ne, vertices, edges, eltype, edgetype, has_edge, has_vertex,
+    inneighbors, outneighbors, is_directed, add_edge!
+
+import SimpleWeightedGraphs:
+    add_edge!, get_weight
+
+import Base:
+    eltype, zero
 
 ### LightGraphs interface
 nv(g::AbstractSpatialGraph) = nv(g.graph)
@@ -14,3 +23,8 @@ inneighbors(g::AbstractSpatialGraph, v) = inneighbors(g.graph, v)
 outneighbors(g::AbstractSpatialGraph, v) = outneighbors(g.graph, v)
 is_directed(g::AbstractSpatialGraph) = is_directed(g.graph)
 Base.zero(g::AbstractSpatialGraph) = zero(g.graph)
+add_edge!(g::AbstractSpatialGraph, a::Integer, b::Integer, c::Number) = add_edge!(g.graph, a, b, c)
+
+### SimpleWeightedGraphs
+get_weight(g::WeightedRasterGraph, a::Integer, b::Integer) = get_weight(g.graph, a, b)
+get_weight(g::WeightedRasterDiGraph, a::Integer, b::Integer) = get_weight(g.graph, a, b)