RF: changed dnodecom to node_degree_by_community for clarity

Author: CindeeM

brainx/tests/test_weighted_modularity.py

@@ -128,10 +128,10 @@ def test_internal_links(self):
 
 
 
-    def test_dnodecom(self):
+    def test_node_degree_by_community(self):
         part = wm.WeightedPartition(self.graph) # one comm per node
         node = 0
-        node2comm_weights = part.dnodecom(node)
+        node2comm_weights = part.node_degree_by_community(node)
         # self loops not added to weight
         # so communities made only of node should be zero
         npt.assert_equal(node2comm_weights[0],0)
@@ -140,7 +140,7 @@ def test_dnodecom(self):
         expected = self.graph[node][neighbor]['weight']
         npt.assert_equal(node2comm_weights[neighbor],expected)
         part = wm.WeightedPartition(self.graph, self.communities)
-        node2comm_weights = part.dnodecom(node)
+        node2comm_weights = part.node_degree_by_community(node)
         npt.assert_equal(len(node2comm_weights), 2)
 
 

brainx/weighted_modularity.py

@@ -100,8 +100,13 @@ def node_degree(self, node):
         return self.graph.degree(weight='weight')[node]
 
 
-    def dnodecom(self, node):
-        """ Find the number of links from node to each community"""
+    def node_degree_by_community(self, node):
+        """ Find the number of links from a node to each community
+        Returns
+        -------
+        comm_weights : list
+            list holding the weighted degree of a node to each community
+        """
         comm_weights = [0] * len(self.communities)
         for neighbor, data in self.graph[node].items():
             if neighbor == node:
@@ -278,7 +283,7 @@ def _calc_delta_modularity(self, node, part):
         communities
         deltamod = inC - totc * ki / total_weight"""
         noded = part.node_degree(node)
-        dnc = part.dnodecom(node)
+        dnc = part.node_degree_by_community(node)
         totc = self._communities_nodes_alledgesw(part, node)
         total_weight = part.total_edge_weight
         # cast to arrays to improve calc