Vertex attributes for artifacts #229

joba00002 · 2022-08-05T16:34:41Z

Addresses #170

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

Changelog

bockthom

Thanks for your additions to this PR @joba00002. Sorry for the late reply, we were very busy during the last weeks.
I had a quick look at your recent changes and spotted a few possible copy-paste errors or statements that need more documentation, etc., please see my individual comments below.

In addition, I checked the list of vertex attributes in #170. Could you please tick all the attributes you already have implemented? From what I have seen now, only two vertex attributes are still missing, right?

number of comments in an issue (there is an attribute for events already, but maybe someone would like to count the comments only even if all events are configured to be considered for network construction)
originating mailing list

Please let us know if you have further questions regarding that.

util-data-misc.R

joba00002 · 2022-09-13T10:52:57Z

I wanted to tick the ones I have implemented, however, GitHub doesn't seem to allow me to do so. I might not have the necessary permissions to edit that issue.

Regarding the originating mailing lists of mail threads, I thought you said in a meeting that the thread ID contains the index of the mailing list as listed in the config file.
However, at least in the sample data, this does not appear to be the case, so I currently don't see a way of linking a thread to its originating mailing list.

Add metrics for issues and mail threads. Signed-off-by: Jonathan Baumann <[email protected]>

Includes start and end dates, contributor count and activity count. Signed-off-by: Jonathan Baumann <[email protected]>

Added myself to util-networks-covariates.R and util-data-misc.R Signed-off-by: Jonathan Baumann <[email protected]>

Inserted line breaks for lines that were longer than 120 characters. Signed-off-by: Jonathan Baumann <[email protected]>

Also adjust default names and default values. Signed-off-by: Jonathan Baumann <[email protected]>

Includes date an artifact was added, issue titles, and whether an issue is a pull request. Signed-off-by: Jonathan Baumann <[email protected]>

Fix a broken function, avoid code duplication Signed-off-by: Jonathan Baumann <[email protected]>

Only counts the number of comments, not other issue events. Signed-off-by: Jonathan Baumann <[email protected]>

Also includes artifact last edited date Signed-off-by: Jonathan Baumann <[email protected]>

For issues only, PRs only, and both Signed-off-by: Jonathan Baumann <[email protected]>

Also includes some tests. Signed-off-by: Jonathan Baumann <[email protected]>

Old names were confusing, at least this is a consistent pattern Signed-off-by: Jonathan Baumann <[email protected]>

issue.event.count, issue.comment.event.count, and issue.is.pull.request Signed-off-by: Jonathan Baumann <[email protected]>

issue.opened.date, issue.closed.date, issue.last.activity.date, issue.title Signed-off-by: Jonathan Baumann <[email protected]>

As the `issue.state` only displays "open" or "closed", this vertex attribute can additionally determine whether a PR was closed by merging or rejected. Signed-off-by: Jonathan Baumann <[email protected]>

bockthom

Today, I've gotten round to review this PR. Thanks for your excellent work on this PR @joba00002!

I could not yet have a look at all of the tests as checking the expected data is very exhausting. I aim at checking the expected results on a sample basis later this week.

Except for the tests, I did a detailed review and spotted a few minor issues that need to be fixed. Please have a closer look at my individual comments. If anything is unclear, please don't hesitate to ask.

util-data-misc.R

util-networks-covariates.R

tests/test-networks-covariates.R

incorrect log messages, more comments, reopened merge requests now count as open, and events with multiple lines now only counted once. Signed-off-by: Jonathan Baumann <[email protected]>

While this is not necessary now, it's possible that filtering options may change in the future, making this useful. Signed-off-by: Jonathan Baumann <[email protected]>

Codeface produces thread IDs prefixed with the mailing list ID. Test data now reflects this. Signed-off-by: Jonathan Baumann <[email protected]>

for each mailing list vertex, adds an attribute with the identifier of the corresponding mailing list. Currently, this is just a number, as no further information is provided by codeface. Signed-off-by: Jonathan Baumann <[email protected]>

In the currently used R containers in our CI pipeline, the installation of R package 'systemfonts' (which is a dependency of package 'ggraph') fails as the system library 'libfontconfig1-dev' is not installed within these containers. Hence, install 'libfontconfig1-dev' within the pipeline before executing the test scripts. Signed-off-by: Thomas Bock <[email protected]>

Signed-off-by: Thomas Bock <[email protected]>

bockthom

Thanks @joba00002 for all the efforts, looks good to me!

I just spotted a couple of spacing inconsistencies. Please fix them and add your changes to the NEWS.md, and then this PR is ready to merge.

util-data-misc.R

tests/test-networks-covariates.R

@return

Spaces around +, newlines before '@return' Signed-off-by: Jonathan Baumann <[email protected]>

Signed-off-by: Jonathan Baumann <[email protected]>

joba00002 force-pushed the artifact_attributes branch 3 times, most recently from c93428d to 2922050 Compare August 10, 2022 10:58

bockthom reviewed Sep 10, 2022

View reviewed changes

util-data-misc.R Outdated Show resolved Hide resolved

util-data-misc.R Outdated Show resolved Hide resolved

util-data-misc.R Outdated Show resolved Hide resolved

joba00002 force-pushed the artifact_attributes branch 2 times, most recently from 407b18a to 28f3732 Compare September 13, 2022 15:30

joba00002 added 11 commits September 27, 2022 15:24

Add artifact metrics (to be used as vertex attributes)

2072807

Add metrics for issues and mail threads. Signed-off-by: Jonathan Baumann <[email protected]>

Add new vertex attributes for issues and mail threads

51b5478

Includes start and end dates, contributor count and activity count. Signed-off-by: Jonathan Baumann <[email protected]>

Add name to copyright header

efa6301

Added myself to util-networks-covariates.R and util-data-misc.R Signed-off-by: Jonathan Baumann <[email protected]>

Fix style in util-networks-covariates.R

7f7abfe

Inserted line breaks for lines that were longer than 120 characters. Signed-off-by: Jonathan Baumann <[email protected]>

Handle issue type in vertex attribute names

fe5dc61

Also adjust default names and default values. Signed-off-by: Jonathan Baumann <[email protected]>

Add more vertex attributes

56ed57a

Includes date an artifact was added, issue titles, and whether an issue is a pull request. Signed-off-by: Jonathan Baumann <[email protected]>

Incorporate suggestions from review

d466419

Fix a broken function, avoid code duplication Signed-off-by: Jonathan Baumann <[email protected]>

Add vertex attribute issue.comment.event.count

9b06036

Only counts the number of comments, not other issue events. Signed-off-by: Jonathan Baumann <[email protected]>

Add tests for mail thread vertex attributes

b56c1c7

Also includes artifact last edited date Signed-off-by: Jonathan Baumann <[email protected]>

Add test for vertex attribute issue.contributor.count

4c903f5

For issues only, PRs only, and both Signed-off-by: Jonathan Baumann <[email protected]>

Allow selecting filtered or unfiltered commit data for vertex attributes

b77601d

Also includes some tests. Signed-off-by: Jonathan Baumann <[email protected]>

joba00002 force-pushed the artifact_attributes branch 2 times, most recently from 6a1bb14 to 2fb72e7 Compare September 27, 2022 14:04

joba00002 added 4 commits September 27, 2022 16:49

Rename author vertex attributes to include author prefix

75e8514

Old names were confusing, at least this is a consistent pattern Signed-off-by: Jonathan Baumann <[email protected]>

Add more tests for issue vertex attributes

811c910

issue.event.count, issue.comment.event.count, and issue.is.pull.request Signed-off-by: Jonathan Baumann <[email protected]>

Add tests for remaining issue vertex attributes

dade8f3

issue.opened.date, issue.closed.date, issue.last.activity.date, issue.title Signed-off-by: Jonathan Baumann <[email protected]>

Add vertex attribute PR closed, merged, or open

52d40ba

As the `issue.state` only displays "open" or "closed", this vertex attribute can additionally determine whether a PR was closed by merging or rejected. Signed-off-by: Jonathan Baumann <[email protected]>

joba00002 force-pushed the artifact_attributes branch from 2fb72e7 to 52d40ba Compare September 27, 2022 14:49

bockthom requested changes Oct 3, 2022

View reviewed changes

joba00002 added 4 commits October 7, 2022 20:47

Incorporate suggestions from review

689a82c

incorrect log messages, more comments, reopened merge requests now count as open, and events with multiple lines now only counted once. Signed-off-by: Jonathan Baumann <[email protected]>

Add use.unfiltered.data parameter to all issue attributes

922258c

While this is not necessary now, it's possible that filtering options may change in the future, making this useful. Signed-off-by: Jonathan Baumann <[email protected]>

Change test data to match codeface results

8b5eaaa

Codeface produces thread IDs prefixed with the mailing list ID. Test data now reflects this. Signed-off-by: Jonathan Baumann <[email protected]>

add vertex attribute originating mailing list

e91161c

for each mailing list vertex, adds an attribute with the identifier of the corresponding mailing list. Currently, this is just a number, as no further information is provided by codeface. Signed-off-by: Jonathan Baumann <[email protected]>

bockthom added 2 commits October 11, 2022 21:08

Add R version 4.2.1 to CI test pipeline

b17e092

Signed-off-by: Thomas Bock <[email protected]>

bockthom reviewed Oct 12, 2022

View reviewed changes

util-data-misc.R Outdated Show resolved Hide resolved

util-data-misc.R Outdated Show resolved Hide resolved

util-data-misc.R Outdated Show resolved Hide resolved

tests/test-networks-covariates.R Outdated Show resolved Hide resolved

Fix spacing

1881275

Spaces around +, newlines before '@return' Signed-off-by: Jonathan Baumann <[email protected]>

joba00002 force-pushed the artifact_attributes branch from 98179aa to 3a4b794 Compare October 22, 2022 10:29

Update NEWS.md

aac337c

Signed-off-by: Jonathan Baumann <[email protected]>

joba00002 force-pushed the artifact_attributes branch from 3a4b794 to aac337c Compare October 22, 2022 10:31

bockthom approved these changes Oct 24, 2022

View reviewed changes

bockthom added the enhancement label Oct 24, 2022

bockthom added this to the v4.2 milestone Oct 24, 2022

bockthom merged commit 68c0515 into se-sic:dev Oct 24, 2022

bockthom mentioned this pull request Oct 28, 2022

Version 4.2 #230

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Vertex attributes for artifacts #229

Vertex attributes for artifacts #229

joba00002 commented Aug 5, 2022 •

edited

Loading

bockthom left a comment

joba00002 commented Sep 13, 2022

bockthom left a comment

bockthom left a comment

Vertex attributes for artifacts #229

Vertex attributes for artifacts #229

Conversation

joba00002 commented Aug 5, 2022 • edited Loading

Prerequisites

Description

Changelog

bockthom left a comment

Choose a reason for hiding this comment

joba00002 commented Sep 13, 2022

bockthom left a comment

Choose a reason for hiding this comment

bockthom left a comment

Choose a reason for hiding this comment

joba00002 commented Aug 5, 2022 •

edited

Loading