Backward compability in JSON_Format and Tutorials updated

Author: pszufe

Project.toml

@@ -1,6 +1,6 @@
 name = "SimpleHypergraphs"
 uuid = "aa4a32ff-dd5d-5357-90e3-e7a9512f0501"
-version = "0.3.3"
+version = "0.3.4"
 authors = ["Przemysław Szufel <pszufe@sgh.waw.pl>", "Bogumił Kamiński <bkamins@sgh.waw.pl>", "Carmine Spagnuolo <spagnuolocarmine@gmail.com>", "Alessia Antelmi <aless.antelmi@gmail.com>", "Evan Walter Clark Spotte-Smith <espottesmith@gmail.com>"]
 
 [deps]

README.md

@@ -52,8 +52,8 @@ Antelmi, A., Cordasco, G., Kamiński, B., Prałat, P., Scarano, V., Spagnuolo, C
 The full paper is available at [https://doi.org/10.24166/im.01.2020](https://doi.org/10.24166/im.01.2020)
 
 ## Acknowledgement
-The research is financed by NAWA - The Polish National Agency for Academic Exchange.
-
+- The research was initially financed by NAWA - The Polish National Agency for Academic Exchange.
+- The development of HIF standard format support for exchange of hypergraphs was financed by the National Science Centre (NCN), Poland (grant number: 2021/41/B/HS4/03349).
 
 [docs-latest-img]: https://img.shields.io/badge/docs-latest-blue.svg
 [docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
@@ -62,7 +62,7 @@ The research is financed by NAWA - The Polish National Agency for Academic Excha
 [tutorial-url]: https://nbviewer.jupyter.org/github/pszufe/SimpleHypergraphs.jl/blob/master/tutorials/basics/SimpleHypergraphs_tutorial_v4.ipynb
 [got-url]: https://nbviewer.jupyter.org/github/pszufe/SimpleHypergraphs.jl/blob/master/tutorials/basics/A%20case%20study%20-%20Game%20of%20Thrones.ipynb
 
-[tutorial-raw]: https://github.com/pszufe/SimpleHypergraphs.jl/raw/master/tutorials/basics/SimpleHypergraphs_tutorial_v4.ipynb
+[tutorial-raw]: https://github.com/pszufe/SimpleHypergraphs.jl/raw/master/tutorials/basics/SimpleHypergraphs_tutorial_v5.ipynb
 [got-raw]: https://github.com/pszufe/SimpleHypergraphs.jl/raw/master/tutorials/basics/A%20case%20study%20-%20Game%20of%20Thrones.ipynb
 
 [travis-img]: https://travis-ci.org/pszufe/SimpleHypergraphs.jl.svg?branch=master

src/io.jl

@@ -213,20 +213,32 @@ function hg_load(
         E = Nothing
     ) where {H <: AbstractSimpleHypergraph, U <: Real}
     json_hg = JSON.parse(read(io, String))
+    if json_hg.m isa String
+        json_hg.m = JSON.parse(json_hg.m)
+    end
+    if json_hg.v2he isa String
+        json_hg.v2he = JSON.parse(json_hg.v2he)
+    end
+    if json_hg.v_meta isa String
+        json_hg.v_meta = JSON.parse(json_hg.v_meta)
+    end
+    if json_hg.he_meta isa String
+        json_hg.he_meta = JSON.parse(json_hg.he_meta)
+    end
     m = reshape(Vector{Union{T, Nothing}}(json_hg.m), json_hg.n, json_hg.k)
 
     V2 = (V == :auto) ? ("v_meta" ∈ keys(json_hg) && length(json_hg.v_meta) > 0 ? elemtypes(json_hg.v_meta) : Nothing) : V
     E2 = (E == :auto) ? ("he_meta" ∈ keys(json_hg) && length(json_hg.he_meta) > 0 ? elemtypes(json_hg.he_meta) : Nothing) : E
 
     if V2 != Nothing && E2 != Nothing && hasvertexmeta(HType) && hashyperedgemeta(HType)
-        v_meta = Vector{Union{V2, Nothing}}(json_hg.v_meta)
-        he_meta = Vector{Union{E2, Nothing}}(json_hg.he_meta)
+        v_meta  = Union{V2, Nothing}[isnothing(e) ? e : V2(e) for e in json_hg.v_meta]
+        he_meta = Union{E2, Nothing}[isnothing(e) ? e : E2(e) for e in json_hg.he_meta]
         h = HType{T, V2, E2, D}(m; v_meta, he_meta)
     elseif V2 != Nothing && hasvertexmeta(HType)
-        v_meta = Vector{Union{V2, Nothing}}(json_hg.v_meta)
+        v_meta = Union{V2, Nothing}[isnothing(e) ? e : V2(e) for e in json_hg.v_meta]
         h = HType{T, V2, D}(m; v_meta=v_meta)
     elseif E2 != Nothing && hashyperedgemeta(HType)
-        he_meta = Vector{Union{E2, Nothing}}(json_hg.he_meta)
+        he_meta = Union{E2, Nothing}[isnothing(e) ? e : E2(e) for e in json_hg.he_meta]
         h = HType{T, E2, D}(m; he_meta=he_meta)
     else
         h = HType{T, V2, E2, D}(m)

test/hif-standard-tests.jl

@@ -72,6 +72,10 @@ end
 #==
 using Revise
 using SimpleHypergraphs
+pathof(SimpleHypergraphs)
+pth = joinpath(dirname(pathof(SimpleHypergraphs)),"..","tutorials", "basics", "data", "hg_seasons_all.json");
+h = SimpleHypergraphs.hg_load(pth; format=JSON_Format(), T=Int, V=Symbol, E=Symbol);
+
 cd("test")
 full_path = "data/HIF-standard/missing_direction.json"
 run(`cat $full_path`);
@@ -83,4 +87,4 @@ h_loaded2 = hg_load(seekstart(io_h2), HIF_Format(); T=Int, show_warning=true, ad
 h2 == h_loaded2
 h2.v_meta == h_loaded2.v_meta
 h2.he_meta == h_loaded2.he_meta
-==#
+==#

tutorials/README.md

@@ -6,9 +6,11 @@ For better visualization, open the notebooks on [nbviewer](https://nbviewer.jupy
 - [Basics][basic-url] — for a quick start with `SimpleHypergraphs.jl`.
 - [A Game of Thrones use case][got-url] — check out how you can exploit the library to gather insights into real-world networks through a case study of the Game of Thrones TV series.
 - [Visualizing hypegraphs][viz-url] — take a look at this notebook for more in-depth insight about visualization functionalities.
+- [Working with HIF standard format][viz-hif] — use case scenario showing a use of HIF standard.
 
 
 
-[basic-url]: https://nbviewer.jupyter.org/github/pszufe/SimpleHypergraphs.jl/blob/master/tutorials/basics/SimpleHypergraphs_tutorial_v4.ipynb
+[basic-url]: https://nbviewer.jupyter.org/github/pszufe/SimpleHypergraphs.jl/blob/master/tutorials/basics/SimpleHypergraphs_tutorial_v5.ipynb
 [got-url]: https://nbviewer.jupyter.org/github/pszufe/SimpleHypergraphs.jl/blob/master/tutorials/basics/A%20case%20study%20-%20Game%20of%20Thrones.ipynb
 [viz-url]: https://nbviewer.jupyter.org/github/pszufe/SimpleHypergraphs.jl/blob/master/tutorials/viz/Visualizing_hypergraphs.ipynb
+[viz-hif]: https://nbviewer.jupyter.org/github/pszufe/SimpleHypergraphs.jl/blob/master/tutorials/hif-standard/HIF-SimpleHypergraphs-demo.ipynb