Complement commit count vertex attribute possibilities #127

klaraschlueter · 2018-05-30T13:40:07Z

Added

Possibility to add the commit count per person as vertex attribute, counting either commits, where the person ist committer AND author, or committer OR author

Changed/Improved

Fixed

Change the type of all commit count default values to Integer

The function takes project data and returns a dataframe containing the commit count per person counting commits, where the person is author and committer. Works with SQL, analogous to other methods in the same file. It is used for the adding the commit count as vertex attribute. Signed-off-by: Klara Schlueter <schluete@fim.uni-passau.de>

… attribute The function adds the commit count per person (counting commits, where the person is the author AND the committer) to the vertices of the networks given as a list, analogous to already existing functions in the same class. Signed-off-by: Klara Schlueter <schluete@fim.uni-passau.de>

Signed-off-by: Klara Schlueter <schluete@fim.uni-passau.de>

The function takes project data and returns a dataframe containing the commit count per person (counting commits, where the person is author OR committer), working wie SQL, analogous to already existing methods in the same file.

The function adds the commit count per person (counting the commits, where the person is author OR commiter) as attributes to the vertices of the given networks, working analogous to already existing methods in the same file. Signed-off-by: Klara Schlueter <schluete@fim.uni-passau.de>

The commit data in the test data is complemented by committer information in addition to author information. Signed-off-by: Klara Schlueter <schluete@fim.uni-passau>

Signed-off-by: Klara Schlueter <schluete@fim.uni-passau.de>

The functions for adding a commit count as vertex attribute set as default value an Integer now. Signed-off-by: Klara Schlueter <schluete@fim.uni-passau.de>

As committer data was added to test commit data earlier, the tests for reading and cutting the test project data expected incomplete data. To resolve this, tests in test-data-cut.R, test-network-cut.R and test-read.R are adapted to the new test data. Signed-off-by: Klara Schlueter <schluete@fim.uni-passau.de>

Signed-off-by: Klara Schlueter <schluete@fim.uni-passau.de>

clhunsen

Thank you very much for your enhancements, @klaraschlueter. Nice work! 👍

Overall, the code looks good to me, there are just some small things that can be improved in an additional commit. (You can use ef094eb as an reference for the commit message.)

clhunsen · 2018-05-31T07:34:10Z

NEWS.md

+## unversioned
+
+### Added
+- Possibility to add the commit count per person as vertex attribute, counting either commits, where the person ist committer AND author, or committer OR author 


Please add the respective issue IDs and commit hashes to the added changes in the changelog file. You do not need to add all hashes if there are several, but the most important ones should be listed (i.e., those commits where the basic functionality is added, not all the test-suite enhancements). See below for the examples.

Additionally, "ist" is not an English word. 😉

Please also add the addition of committer information to the test data (see tests/codeface-data/results/testing/test_feature/feature/commits.list) to the Changed/Improved part of the changelog.

clhunsen · 2018-05-31T08:05:16Z

util-core-peripheral.R

@@ -522,6 +522,66 @@ get.committer.not.author.commit.count = function(range.data) {
    return(res)
 }

+#' Get the commit count per person in the given range data for commits where the author equals the commiter.


"committer"

clhunsen · 2018-05-31T11:14:56Z

util-core-peripheral.R

+    return(res)
+}
+
+#' Get the commit count per person in the given range data where it is commiter or author or both.


"... where the person is committer or author or both."

clhunsen · 2018-05-31T12:02:42Z

util-core-peripheral.R

+
+    ## Execute queries to get the commit count per person
+    ungrouped = sqldf::sqldf("SELECT `committer.name` AS `name` FROM `commits.df`
+                             WhERE `committer.name` = `author.name`


clhunsen · 2018-05-31T12:05:33Z

util-networks-covariates.R

+#'                          \code{"project.cumulative"}, \code{"project.all.ranges"}, and
+#'                          \code{"complete"}. See \code{split.data.by.networks} for
+#'                          more details. [default: "range"]
+#' @param default.value The default value to add if a vertex has no matching value [default: 0]


The default value is 0L.

clhunsen · 2018-05-31T12:06:22Z

util-networks-covariates.R

@@ -134,7 +134,7 @@ add.vertex.attribute.commit.count.author = function(list.of.networks, project.da
                                                    aggregation.level = c("range", "cumulative", "all.ranges",
                                                                          "project.cumulative", "project.all.ranges",
                                                                          "complete"),
-                                                    default.value = 0) {
+                                                    default.value = 0L) {


Please update the function ocumentation regarding the new default value. This also holds for all other changed default values below.

hechtlC · 2018-06-01T14:04:21Z

util-networks-covariates.R

@@ -223,6 +223,61 @@ add.vertex.attribute.commit.count.committer.not.author = function(list.of.networ
    return(nets.with.attr)
 }

+#' Add commit-count attribute based on comitter name where the committer equals the author.


"committer" is once written with one m and once with two

hechtlC · 2018-06-01T14:07:30Z

util-core-peripheral.R

+    logging::logdebug("get.committer.or.author.commit.count: finished.")
+    return(res)
+}
+
 #' Get the commit count per comitter in the given range data, where the committer


"committer" is once written with one m and once with two
I know this is not your code. But the copy-paste-error below should be originated here. Maybe you can change it here as well.

Signed-off-by: Klara Schlueter <schluete@fim.uni-passau.de>

clhunsen · 2018-06-06T13:57:25Z

Thank you very much for your additions to the network library, @klaraschlueter. Nice work! 👍

Klara added 11 commits May 30, 2018 15:23

Correct documentation and logging

4825f15

Signed-off-by: Klara Schlueter <schluete@fim.uni-passau.de>

Add committer data to test data for further tests

78509c2

The commit data in the test data is complemented by committer information in addition to author information. Signed-off-by: Klara Schlueter <schluete@fim.uni-passau>

Add test for "add.vertex.attribute.commit.count.committer.and.author"

d3f8d59

Signed-off-by: Klara Schlueter <schluete@fim.uni-passau.de>

Change type of default value for vertex attributes to Integer

62c0339

The functions for adding a commit count as vertex attribute set as default value an Integer now. Signed-off-by: Klara Schlueter <schluete@fim.uni-passau.de>

Add test for "add.vertex.attribute.commit.count.committer.or.author"

61c8a34

Signed-off-by: Klara Schlueter <schluete@fim.uni-passau.de>

Adapt NEWS.md

3241df1

Signed-off-by: Klara Schlueter <schluete@fim.uni-passau.de>

clhunsen requested changes May 31, 2018

View reviewed changes

clhunsen added the enhancement label May 31, 2018

clhunsen added this to the v3.3 milestone May 31, 2018

hechtlC reviewed Jun 1, 2018

View reviewed changes

clhunsen added fixed/in-progress and removed fixed/in-progress labels Jun 6, 2018

Improvements suggested by review

a8ea25b

Signed-off-by: Klara Schlueter <schluete@fim.uni-passau.de>

clhunsen approved these changes Jun 6, 2018

View reviewed changes

clhunsen merged commit f4aaa44 into se-sic:dev Jun 6, 2018

clhunsen mentioned this pull request Jun 7, 2018

Templates, README, and small stuff #128

Merged

6 tasks

clhunsen mentioned this pull request Jul 24, 2018

Further vertex attributes #92

Closed

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Complement commit count vertex attribute possibilities #127

Complement commit count vertex attribute possibilities #127

klaraschlueter commented May 30, 2018

clhunsen left a comment

clhunsen May 31, 2018

clhunsen May 31, 2018

clhunsen May 31, 2018

clhunsen May 31, 2018

clhunsen May 31, 2018

clhunsen May 31, 2018

hechtlC Jun 1, 2018

hechtlC Jun 1, 2018

clhunsen commented Jun 6, 2018

Complement commit count vertex attribute possibilities #127

Complement commit count vertex attribute possibilities #127

Conversation

klaraschlueter commented May 30, 2018

Added

Changed/Improved

Fixed

clhunsen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

clhunsen commented Jun 6, 2018