Radius and Eccentricity

[hcars]

Modifications:

(new algorithms, added tests or documentation)

• Adds an eccentricity method.
• Adds a radius method.

Impacted submodules:

(e.g. sknetwork.topology)

• sknetwork.path

This pull request:

(your PR must match these criteria before review)

• [x] targets the develop branch
• [x] does not decrease code coverage
• [x] passes the tests
• [x] is documented and the documentation build passes
• [x] has PEP8-compliant code and explicit variable naming
• [ ] has a tutorial (facultative but recommended)

Any doubts about some technicalities? Do not hesitate to look at the dedicated Wiki.

[QLutz]

Hello,

Thank you for contributing!

We appreciate the functionalities you've added and would like you to make a few adjustments and corrections before we can merge your branch:

• for radius, add a parameter n_sources similar to that present in the diameter function. That will make it possible to have an approximation even on large graphs.
• still in radius, rather than using the eccentricity function and map, compute all distances between from all sources at once to enable faster computations (as the parallelism will be more efficient). Then take the max of each line and finally the min of those maxima.
• update the docs in the docs/ folder (have a glance at the Wiki for indications)
• update the docstrings of each function by adding examples (or at least removing the empty sections for examples)

[QLutz]

I've also made some corrections for the function names we were in the process of making.

Beware of PEP8 styling. In particular, no line in the code should be more than 120 characters long.

[hcars]

I addressed the first 3 of your bullets. I added the methods to the path.rst file, but I'm not sure if that's sufficient.

[codecov[bot]]

Codecov Report

Merging #522 (5455670) into develop (bd842b4) will increase coverage by 0.01%. The diff coverage is 100.00%.

@@             Coverage Diff             @@
##           develop     #522      +/-   ##
===========================================
+ Coverage    98.55%   98.57%   +0.01%     
===========================================
  Files          170      173       +3     
  Lines         7216     7295      +79     
===========================================
+ Hits          7112     7191      +79     
  Misses         104      104              

Impacted Files	Coverage Δ
sknetwork/path/__init__.py	100.00% <100.00%> (ø)
sknetwork/path/metrics.py	100.00% <100.00%> (ø)
sknetwork/path/shortest_path.py	100.00% <100.00%> (ø)
sknetwork/path/tests/test_metrics.py	100.00% <100.00%> (ø)
sknetwork/path/tests/test_shortest_path.py	100.00% <100.00%> (ø)
sknetwork/data/load.py	94.44% <0.00%> (ø)
sknetwork/data/models.py	100.00% <0.00%> (ø)
sknetwork/ranking/__init__.py	100.00% <0.00%> (ø)
sknetwork/ranking/diffusion.py
sknetwork/ranking/tests/test_diffusion.py
... and 5 more

:mega: Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

[QLutz]

Thank you for your corrections. The last few steps before merging are the following:

• I added your name to the AUTHORS and HISTORY files. Make sure that the spelling is correct.
• I recently added a code coverage test. It currently does not pass. Please add a test for the exception handling you added in the get_distances function (in both the n_jobs == 1 and n_jobs > 1 cases).

[hcars]

You're welcome! I just added checks for those.