RF: changed total_weights to degree_by_community for clarity

Author: CindeeM

brainx/tests/test_weighted_modularity.py

@@ -109,11 +109,11 @@ def test_modularity(self):
         npt.assert_almost_equal(part.modularity(), 0.0555463)
 
 
-    def test_total_links(self):
+    def test_degree_by_community(self):
         part = wm.WeightedPartition(self.graph) # one comm per node
         ## summ of all links in or out of communities
         ## since one per scommunity, just weighted degree of each node
-        tot_per_comm = part.total_links()
+        tot_per_comm = part.degree_by_community()
         degw = self.graph.degree(weight='weight').values()
         self.assertEqual(tot_per_comm, degw)
         ## This isnt true of we have communities with multiple nodes

brainx/weighted_modularity.py

@@ -116,9 +116,13 @@ def node_degree_by_community(self, node):
         return comm_weights
 
 
-    def total_links(self):
-        """ sum of all links inside or outside community
-        no nodes are missing"""
+    def degree_by_community(self):
+        """ sum of all edges within or between communities
+        for each community
+        Returns
+        -------
+        weights : list
+            list is size of total number of communities"""
         comm = self.communities
         weights = [0] * len(comm)
         all_degree_weights = self.graph.degree(weight='weight')
@@ -173,7 +177,7 @@ def modularity(self):
 
         m2 = self.total_edge_weight
         internal_connect = np.array(self.internal_links())
-        total = np.array(self.total_links())
+        total = np.array(self.degree_by_community())
         return np.sum(internal_connect/m2 - (total/(2*m2))**2)