Adding commit-interactions

README.md

@@ -607,6 +607,9 @@ There is no way to update the entries, except for the revision-based parameters.
 - `commit.interactions`:
     * Allow construction of author and artifact networks using commit-interaction data
     * [`TRUE`, *`FALSE`*]
+- `filter.commit.interactions`:
+    * Filter out entries from commit interaction data that are not matched to a specific function or file
+    * [*`TRUE`*, `FALSE`]
 
 ### NetworkConf
 

tests/test-data.R

@@ -526,6 +526,7 @@ test_that("Compare two ProjectData Objects with commit.interactions", {
     proj.conf$update.value("commit.interactions", TRUE)
     proj.conf$update.value("commits.filter.untracked.files", FALSE)
     proj.conf$update.value("commits.filter.base.artifact", FALSE)
+    proj.conf$update.value("filter.commit.interactions", FALSE)
 
     proj.data.one = ProjectData$new(project.conf = proj.conf)
     proj.data.two = proj.data.one$clone(deep = TRUE)
@@ -588,4 +589,8 @@ test_that("Compare two ProjectData Objects with commit.interactions", {
     commit.interactions.data.expected[["base.file"]] = c("test2.c", "test2.c", "test3.c", "test2.c")
 
     expect_equal(proj.data.two$get.commit.interactions(), commit.interactions.data.expected)
+
+    ## reactivate filtering of commit interactions
+    proj.data.two$set.project.conf.entry("filter.commit.interactions", TRUE)
+    expect_true(nrow(proj.data.two$get.commit.interactions()) == 2)
 })

tests/test-networks-artifact.R

@@ -219,6 +219,7 @@ patrick::with_parameters_test_that("Network construction with commit-interaction
     proj.conf$update.value("commit.interactions", TRUE)
     proj.conf$update.value("commits.filter.untracked.files", FALSE)
     proj.conf$update.value("commits.filter.base.artifact", FALSE)
+    proj.conf$update.value("filter.commit.interactions", FALSE)
     proj.data = ProjectData$new(project.conf = proj.conf)
 
     net.conf = NetworkConf$new()
@@ -267,6 +268,7 @@ patrick::with_parameters_test_that("Network construction with commit-interaction
     proj.conf$update.value("commit.interactions", TRUE)
     proj.conf$update.value("commits.filter.untracked.files", FALSE)
     proj.conf$update.value("commits.filter.base.artifact", FALSE)
+    proj.conf$update.value("filter.commit.interactions", FALSE)
     proj.data = ProjectData$new(project.conf = proj.conf)
 
     net.conf = NetworkConf$new()

tests/test-networks-author.R

@@ -685,6 +685,7 @@ patrick::with_parameters_test_that("Network construction with commit-interaction
     proj.conf$update.value("commit.interactions", TRUE)
     proj.conf$update.value("commits.filter.untracked.files", FALSE)
     proj.conf$update.value("commits.filter.base.artifact", FALSE)
+    proj.conf$update.value("filter.commit.interactions", FALSE)
     proj.data = ProjectData$new(project.conf = proj.conf)
 
     net.conf = NetworkConf$new()

util-conf.R

@@ -474,6 +474,12 @@ ProjectConf = R6::R6Class("ProjectConf", inherit = Conf,
                 allowed = c(TRUE, FALSE),
                 allowed.number = 1
             ),
+            filter.commit.interactions = list(
+                default = TRUE,
+                type = "logical",
+                allowed = c(TRUE, FALSE),
+                allowed.number = 1
+            ),
             custom.event.timestamps.file = list(
                 default = NA,
                 type = "character",

util-data.R

@@ -1273,6 +1273,11 @@ ProjectData = R6::R6Class("ProjectData",
                         commit.interaction.data = read.commit.interactions(data.path)
                     }
 
+                    ## filter commit interactions if configured
+                    if (private$project.conf$get.value("filter.commit.interactions")) {
+                        commit.interaction.data = subset(commit.interaction.data,
+                                                         file != COMMIT.INTERACTION.GLOBAL.FILE.FUNCTION.NAME)
+                    }
                     ## cache the result
                     private$commit.interactions = commit.interaction.data
                     private$update.commit.interactions()