Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Additional Core/Peripheral Classification Methods #276

Merged
merged 15 commits into from
Jan 29, 2025

Conversation

Leo-Send
Copy link
Contributor

@Leo-Send Leo-Send commented Dec 11, 2024

Prerequisites

  • I adhere to the coding conventions (described here) in my code.
  • I have updated the copyright headers of the files I have modified.
  • I have written appropriate commit messages, i.e., I have recorded the goal, the need, the needed changes, and the location of my code modifications for each commit. This includes also, e.g., referencing to relevant issues.
  • I have put signed-off tags in all commits.
  • I have updated the changelog file NEWS.md appropriately.
  • I have checked whether I need to adjust the showcase file showcase.R with respect to my changes.
  • The pull request is opened against the branch dev.

Description

Add four new metric which can be used for the classification of authors into core and peripheral:
Betweenness, which measures the number of shortest paths between developers that go through a given developer vertex;
Closeness, which measures how close a developer is to all others by taking the inverse of the sum of all of it's shortest paths;
Pagerank, which is based on Google's Pagerank algorithm, which is closely related to Eigenvector Centrality;
Eccentricity, which measures the distance to the furthest developer vertex.

Changelog

Added

Changed/Improved

@Leo-Send Leo-Send changed the title Pullrequest Additional Core/Peripheral Classification Methods Dec 11, 2024
Copy link
Collaborator

@bockthom bockthom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had a quick look at the implementation (but not yet at the tests).
Please find my initial comments below.

util-core-peripheral.R Outdated Show resolved Hide resolved
util-core-peripheral.R Outdated Show resolved Hide resolved
util-core-peripheral.R Outdated Show resolved Hide resolved
util-core-peripheral.R Outdated Show resolved Hide resolved
NEWS.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@bockthom bockthom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've had a quick look at your additions to the README, see my detailed comments below.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
util-core-peripheral.R Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@Leo-Send Leo-Send marked this pull request as ready for review January 14, 2025 12:47
Copy link
Collaborator

@bockthom bockthom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As I haven't had a look at the tests yet, I have now done so. I only have a few minor comments (but I did not check the actual centrality values; especially for eccentricity, I still don't have an impression whether the values do make sense or not 🙈)

In addition to my comments below, please don't forget about the changes to the README regarding "author networks" that we have agreed on in today's meeting.

tests/test-core-peripheral.R Outdated Show resolved Hide resolved
tests/test-core-peripheral.R Show resolved Hide resolved
tests/test-core-peripheral.R Outdated Show resolved Hide resolved
util-core-peripheral.R Outdated Show resolved Hide resolved
Base implementation for new classification metrics.
Documentation and testing still missing.

Signed-off-by: Leo Sendelbach <[email protected]>
Tests use already existing network, this test cases are quite small.
Additional research into potential rounding errors may be required.

Signed-off-by: Leo Sendelbach <[email protected]>
Add default documentation, same as for already existing
classification methods

Signed-off-by: Leo Sendelbach <[email protected]>
add new entry under 'unversioned"

Signed-off-by: Leo Sendelbach <[email protected]>
Also minor fixes as requested in PR

Signed-off-by: Leo Sendelbach <[email protected]>
Changed ordering in readme

Signed-off-by: Leo Sendelbach <[email protected]>
tests hierarchy with network previously used for another unit test

Signed-off-by: Leo Sendelbach <[email protected]>
formulation change as requested

Signed-off-by: Leo Sendelbach <[email protected]>
NEWS.md now includes update to README

Signed-off-by: Leo Sendelbach <[email protected]>
expanded descripotion of network-based metrics to make clear that
they can be used on any type of network

Signed-off-by: Leo Sendelbach <[email protected]>
Copy link
Collaborator

@bockthom bockthom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just two comments regarding wording:

README.md Outdated Show resolved Hide resolved
NEWS.md Outdated Show resolved Hide resolved
also changed some wording issues in NEWS and README

Signed-off-by: Leo Sendelbach <[email protected]>
also corrected copyright headers

Signed-off-by: Leo Sendelbach <[email protected]>
Copy link

codecov bot commented Jan 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.67%. Comparing base (b018a43) to head (c70a0bb).
Report is 16 commits behind head on dev.

Additional details and impacted files
@@            Coverage Diff             @@
##              dev     #276      +/-   ##
==========================================
+ Coverage   81.13%   81.67%   +0.54%     
==========================================
  Files          16       16              
  Lines        5105     5147      +42     
==========================================
+ Hits         4142     4204      +62     
+ Misses        963      943      -20     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

util-core-peripheral.R Outdated Show resolved Hide resolved
NEWS.md Outdated Show resolved Hide resolved
Changed comment explaining potential issues with hierarchy classification

Signed-off-by: Leo Sendelbach <[email protected]>
util-core-peripheral.R Outdated Show resolved Hide resolved
@bockthom bockthom requested a review from hechtlC January 24, 2025 17:16
@bockthom bockthom added this to the v5.0 milestone Jan 24, 2025
Putting the verb before the adverb

Signed-off-by: Leo Sendelbach <[email protected]>
Copy link
Contributor

@hechtlC hechtlC left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First of all thank you for the enhancement @Leo-Send!
I have just found some small typos and wording issues. Once these are fixed, we can merge this PR.

NEWS.md Outdated Show resolved Hide resolved
util-core-peripheral.R Outdated Show resolved Hide resolved
util-core-peripheral.R Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
implemented feedback on PR

Signed-off-by: Leo Sendelbach <[email protected]>
@hechtlC hechtlC merged commit 4d92c82 into se-sic:dev Jan 29, 2025
9 checks passed
@bockthom bockthom mentioned this pull request Feb 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants