attempt at listing the available statistics

[thomasrobiglio]

This is an attempt at rendering all the available statistics and making them more discoverable as discussed in the docs part of #188.

[codecov]

Codecov Report

Patch coverage has no change and project coverage change: -0.05 ⚠️

Comparison is base (71d8498) 90.95% compared to head (544f511) 90.90%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #405      +/-   ##
==========================================
- Coverage   90.95%   90.90%   -0.05%     
==========================================
  Files          47       47              
  Lines        3893     3916      +23     
==========================================
+ Hits         3541     3560      +19     
- Misses        352      356       +4     

see 3 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[nwlandry]

This is a really great start!! Thanks so much! Here are my thoughts: what if you combine the admonition box (if that's what it's called) with the listing of the classes below and group them by object type. For example,

Hypergraphs and Simplicial Complexes

Available Stats:
{add your list here of NodeStat and EdgeStat methods}

Corresponding modules/classes:
{NodeStat/EdgeStat etc.}

DiHypergraphs

....

[thomasrobiglio]

Thanks @nwlandry for the suggestions and the correction! At the moment I am a bit busy with other projects + wrapping up my msc thesis, I think I will be able to finish this next week... maybe after we have discussed about it in person at netsci 😄

[nwlandry]

Of course! No rush and good luck :)

[nwlandry]

I was just commenting because I found the typo when I was making the presentation for netsci.

[thomasrobiglio]

Now it appears like this - we can discuss in person if we like it or we want to explore other possibilities. @nwlandry hopefully this is what you were hinting at.

[nwlandry]

Two small changes, but I really like what you've done here! Thanks so much!

[thomasrobiglio]

Thank you @nwlandry. I would also like to have approval by @maximelucas as I was working on this with him last week

[leotrs]

Thanks so much. My 2¢: I'd move the "corresponding modules" and "corresponding classes" at the bottom of each section inside the table, as they are only of interest to developers, not to end users, and move the decorators up, for the same reason. The decorators are meant to be user-facing.

[maximelucas]

Thanks Thomas, looks great.

To fully fix #188 I would still add two things (but they could be in another PR):

1. an all_stat() function that would list of all available stats (see this comment)
2. list available stats when user request one that does not exist. Right now, H.nodes.test() raises AttributeError: Stat 'test' not defined. It would be nice if it could also say something like: "NodeStat must be one of ["degree", ...]"

[thomasrobiglio]

Agreed @maximelucas, I think it would be better to do that in another PR. Does someone knows how to 'unlink' this PR to the issue? so that merging the PR does not close the issue

[maximelucas]

Does someone knows how to 'unlink' this PR to the issue? so that merging the PR does not close the issue

Not sure but in case we reopen it manually.