Calculate local clustering coefficient for community detection

Author: JohT

cypher/Community_Detection/Community_Detection_10a_LocalClusteringCoefficient_Estimate.cypher

@@ -0,0 +1,23 @@
+// Community Detection - Local Clustering Coefficient - Estimate
+
+CALL gds.localClusteringCoefficient.write.estimate(
+ $dependencies_projection + '-cleaned', {
+    writeProperty: $dependencies_projection_write_property
+})
+ YIELD requiredMemory
+      ,nodeCount
+      ,relationshipCount
+      ,bytesMin
+      ,bytesMax
+      ,heapPercentageMin
+      ,heapPercentageMax
+      ,treeView
+      ,mapView
+RETURN requiredMemory
+      ,nodeCount
+      ,relationshipCount
+      ,bytesMin
+      ,bytesMax
+      ,heapPercentageMin
+      ,heapPercentageMax
+      ,treeView

cypher/Community_Detection/Community_Detection_10b_LocalClusteringCoefficient_Statistics.cypher

@@ -0,0 +1,7 @@
+// Community Detection - Local Clustering Coefficient - Statistics
+
+CALL gds.localClusteringCoefficient.stats(
+ $dependencies_projection + '-cleaned', {
+})
+ YIELD averageClusteringCoefficient, nodeCount, preProcessingMillis, computeMillis, postProcessingMillis
+RETURN averageClusteringCoefficient, nodeCount, preProcessingMillis, computeMillis, postProcessingMillis

cypher/Community_Detection/Community_Detection_10c_LocalClusteringCoefficient_Mutate.cypher

@@ -0,0 +1,8 @@
+// Community Detection - Local Clustering Coefficient - Mutate
+
+CALL gds.localClusteringCoefficient.mutate(
+ $dependencies_projection + '-cleaned', {
+    mutateProperty: $dependencies_projection_write_property
+})
+ YIELD averageClusteringCoefficient, nodeCount, nodePropertiesWritten, preProcessingMillis, computeMillis, postProcessingMillis, mutateMillis
+RETURN averageClusteringCoefficient, nodeCount, nodePropertiesWritten, preProcessingMillis, computeMillis, postProcessingMillis, mutateMillis

cypher/Community_Detection/Community_Detection_10d_LocalClusteringCoefficient_Stream.cypher

@@ -0,0 +1,13 @@
+// Community Detection - Local Clustering Coefficient - Stream
+
+CALL gds.localClusteringCoefficient.stream(
+ $dependencies_projection + '-cleaned', {
+})
+ YIELD nodeId, localClusteringCoefficient
+  WITH gds.util.asNode(nodeId) AS member
+      ,localClusteringCoefficient
+  WITH coalesce(member.fqn, member.fileName, member.name) AS memberName
+      ,localClusteringCoefficient
+RETURN localClusteringCoefficient
+      ,memberName
+ ORDER BY localClusteringCoefficient DESC, memberName ASC

cypher/Community_Detection/Community_Detection_10d_LocalClusteringCoefficient_Stream_Aggregated.cypher

@@ -0,0 +1,17 @@
+// Community Detection - Local Clustering Coefficient - Stream Aggregated
+
+CALL gds.localClusteringCoefficient.stream(
+ $dependencies_projection + '-cleaned', {
+})
+ YIELD nodeId, localClusteringCoefficient
+  WITH gds.util.asNode(nodeId) AS member
+      ,localClusteringCoefficient
+  WITH coalesce(member.fqn, member.fileName, member.name) AS memberName
+      ,localClusteringCoefficient
+  WITH round(localClusteringCoefficient, 2) AS localClusteringCoefficient
+      ,collect(DISTINCT memberName)[0..9]   AS memberNameExamples
+      ,count(DISTINCT memberName)           AS memberCount
+RETURN localClusteringCoefficient
+      ,memberCount
+      ,memberNameExamples
+ ORDER BY localClusteringCoefficient DESC, memberCount DESC

cypher/Community_Detection/Community_Detection_10e_LocalClusteringCoefficient_Write.cypher

@@ -0,0 +1,8 @@
+// Community Detection - Local Clustering Coefficient - Write
+
+CALL gds.localClusteringCoefficient.write(
+ $dependencies_projection + '-cleaned', {
+    writeProperty: $dependencies_projection_write_property
+})
+ YIELD averageClusteringCoefficient, nodeCount, nodePropertiesWritten, preProcessingMillis, computeMillis, postProcessingMillis, writeMillis
+RETURN averageClusteringCoefficient, nodeCount, nodePropertiesWritten, preProcessingMillis, computeMillis, postProcessingMillis, writeMillis

scripts/reports/CommunityCsv.sh

@@ -322,6 +322,41 @@ calculateCommunityMetrics() {
     # gds.modularity.stream ArrayIndexOutOfBoundsException: Index -1 out of bounds for length 100
 }
 
+# Calculates the Local Clustering Coefficient for each node in the projected graph.
+# It describes the likelihood that the neighbors of a node are also connected.
+# 
+# Required Parameters:
+# - dependencies_projection=...
+#   Name prefix for the in-memory projection name for dependencies. Example: "package"
+# - dependencies_projection_node=...
+#   Label of the nodes that will be used for the projection. Example: "Package"
+# - dependencies_projection_weight_property=...
+#   Name of the node property that contains the dependency weight. Example: "weight"
+calculateLocalClusteringCoefficient() {
+    local COMMUNITY_DETECTION_CYPHER_DIR="${CYPHER_DIR}/Community_Detection"
+    local PROJECTION_CYPHER_DIR="${CYPHER_DIR}/Dependencies_Projection"
+
+    local writePropertyName="dependencies_projection_write_property=communityLocalClusteringCoefficient" 
+    local writeLabelName="dependencies_projection_write_label=MaximumKCut" 
+
+    # Statistics
+    execute_cypher "${COMMUNITY_DETECTION_CYPHER_DIR}/Community_Detection_10a_LocalClusteringCoefficient_Estimate.cypher" "${@}" "${writePropertyName}"
+    
+    # Run the algorithm and write the result into the in-memory projection ("mutate")
+    execute_cypher "${COMMUNITY_DETECTION_CYPHER_DIR}/Community_Detection_10c_LocalClusteringCoefficient_Mutate.cypher" "${@}" "${writePropertyName}"
+
+    # Stream to CSV
+    local nodeLabel
+    nodeLabel=$( extractQueryParameter "dependencies_projection_node" "${@}")
+    execute_cypher "${COMMUNITY_DETECTION_CYPHER_DIR}/Community_Detection_10d_LocalClusteringCoefficient_Stream_Aggregated.cypher" "${@}" "${writePropertyName}" > "${FULL_REPORT_DIRECTORY}/${nodeLabel}_Communities_Local_Clustering_Coefficient_Aggregated.csv"
+    #execute_cypher "${PROJECTION_CYPHER_DIR}/Community_Detection_10d_LocalClusteringCoefficient_Stream.cypher" "${@}" > "${FULL_REPORT_DIRECTORY}/${nodeLabel}_Communities_Local_Clustering_Coefficient.csv"
+    
+    # Update Graph (node properties and labels) using the already mutated property projection
+    execute_cypher "${PROJECTION_CYPHER_DIR}/Dependencies_9_Write_Mutated.cypher" "${@}" "${writePropertyName}"
+    execute_cypher "${PROJECTION_CYPHER_DIR}/Dependencies_10_Delete_Label.cypher" "${@}" "${writePropertyName}" "${writeLabelName}"
+    execute_cypher "${PROJECTION_CYPHER_DIR}/Dependencies_11_Add_Label.cypher" "${@}" "${writePropertyName}" "${writeLabelName}"
+}
+
 # Write modularity for Leiden communities
 # 
 # Required Parameters:
@@ -366,6 +401,7 @@ detectCommunities() {
     time detectCommunitiesWithLeiden "${@}"
     time detectCommunitiesWithKCoreDecomposition "${@}"
     time detectCommunitiesWithApproximateMaximumKCut "${@}"
+    time calculateLocalClusteringCoefficient "${@}"
     compareCommunityDetectionResults "${@}"
     listAllResults "${@}"
 }