Open knapply opened 5 years ago
I sort of like the net_*
and vert_*
prefixes for metrics (e.g., net_cent_degree()
or vert_cent_degree()
) . However, the topo_*
prefix does reflect the vocabulary we use in our training/teaching, which would make it more intuitive for students that we work with.
In all honesty, I am ambivalent as all these terms make sense to me, but I do think we should take a look at how Gephi, ORA and other GUI driven platforms refer to these metrics. If the goal is to make this package intuitive, we should aim to use the most commonly used terms. Thoughts?
I placed a table in the README. The version on the site also links to documentation for most of the functions. It might give a better "global" perspective of my mindset.
I'm really trying to find a good balance in learn-ability/usability that avoids all the problems of the current tools... ideally before we're far enough along that changing a family of functions is really time-consuming.
I like some of the terms used in the GUIs (e.g. ORA's "fold"), but I haven't seen much else that will be useful, but I haven't looked very hard. The GUIs can just be so much more verbose.
We also have to sidestep the nightmare of network/igraph namespace issues. There doesn't seem to be any good solution to do this; If a user loads igraph after our package, it'll nuke any functions that we use... unless we violate CRAN's rules.
I originally planned to use the
net_*()
functions for topography metrics, but that now seems to turn the net-prefix into a bloated "catch-all". Thoughts ontopo_*()
?Priorities w/ some proposed syntax:
topo_*()
node_count()
already exists... considertopo_order()
edge_count()
already exists... considertopo_size()
topo_ei_index()
needs to be moved from knapply/snatoolstopo_density()
topo_avg_distance()
topo_diameter()
topo_centralization()
topo_avg_degree()
topo_cohesion()
topo_compactness()
topo_fragmentation()
topo_reciprocity()
topo_transitivity()
topo_morans_i()
topo_gerrys_c()
@cjcallag @rschroedy @dtcunning @philgroovy, feel free to chime in.