docs: add section targeted towards people coming from MetaGraphs.jl #29
Conversation
|
Thanks for all this! It might take a bit of time to review but I think it's a great idea! |
|
|
||
| Using *MetaGraphsNext.jl*: | ||
| ```@example main | ||
| mg = MetaGraphsNext.MetaGraph(Graph(), default_weight = 3.0) |
There was a problem hiding this comment.
Instead of doing each vertex one at a time, it might be nice to add a constructor to do it all at once. Ref #6?
There was a problem hiding this comment.
Yes! That constructor would be super cool to have. Perhaps I can find some time to implement it. I think I would need some assistance though.
There was a problem hiding this comment.
Ok, let me know if you have any questions.
|
Also, in general, it would be good to format these all as doctests. |
|
|
||
| Using *MetaGraphsNext.jl*: | ||
| ```@example main | ||
| # Not possible since but this is a workaround |
There was a problem hiding this comment.
Not necessarily. You could use a mutable struct or a dict as vertex metadata.
|
|
||
| foreach(x -> add_vertex!(mg, Symbol(x), (name = "", id = missing)), 1:5) | ||
| foreach(x -> add_edge!(mg, Symbol(x[1]), Symbol(x[2]), ""), zip(1:5, 2:5)) | ||
| mg[Symbol(1)] = (name = "Susan", id = 123) |
There was a problem hiding this comment.
This seems confusing. Why not just use a symbol like :index1 or something?
|
|
||
| Using *MetaGraphsNext.jl*: | ||
| ```@example main | ||
| # Not supported. The exact data type of the vertex data needs to be defined |
There was a problem hiding this comment.
You could have a dict with eltype Any as vertex metadata. Not sure that would be advisable, but it would work.
There was a problem hiding this comment.
I think in general, using dicts with eltype Any as vertex metadata might be the best way to show people how to migrate from MetaGraphs to MetaGraphsNext. Then, afterwards, you could talk about using something more strongly typed, like a NamedTuple or mutable struct, might be better if all the metadata has same structure.
All of them? Including the ones running MetaGraphs.jl examples? That means that we would need to add MetaGraphs.jl as a dependency for MetaGraphsNext.jl tests. |
|
Nah, just the MetaGraphsNext ones. Does that make sense? |
Yeap. Take a look at the last commit to make sure we are on the same page. |
|
|
||
| Using *MetaGraphsNext.jl*: | ||
| ```jldoctest main | ||
| # Important: graph data can only be set when constructing the object |
There was a problem hiding this comment.
This is arguably a bug. We could make just this one field mutable on more recent versions of Julia.
|
Thanks! The doctests look good as long as they pass CI. |
I removed the Combinatorics package as a dependency. I think the tests should pass now. |
|
Hey @mroavi, and thank you for your contribution! |
|
Sounds good! |
Hi there. This is my initial attempt to tackle #26.
I basically translated all the examples in the MetaGraphs.jl Example Usage section and put them next to each other on a separate page of the docs.
I'm sure that there are better ways to do this since I'm new to MetaGraphsNext.jl. Looking forward to hearing about them. Let me know what you think.