graphology-metrics - npm Package Compare versions

Comparing version 1.15.0 to 1.16.0

centrality/index.d.ts

 export {default as betweenness} from './betweenness';
 export {default as degree} from './degree';
+export {default as hits} from './hits';
+export {default as pagerank} from './pagerank';

centrality/index.js

@@ -9,1 +9,3 @@ /**
 exports.degree = require('./degree.js');
+exports.hits = require('./hits.js');
+exports.pagerank = require('./pagerank.js');

package.json

 {
   "name": "graphology-metrics",
-  "version": "1.15.0",
+  "version": "1.16.0",
   "description": "Miscellaneous graph metrics for graphology.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -26,2 +26,4 @@ # Graphology metrics
   - [Degree centrality](#degree-centrality)
+  - [HITS](#hits)
+  - [Pagerank](#pagerank)
 - [Degree](#degree)
@@ -247,2 +249,61 @@ - [Eccentricity](#eccentricity)
 
+### HITS
+
+Computes the hub/authority metrics for each node using the HITS algorithm.
+
+```js
+import hits from 'graphology-metrics/centrality/hits';
+
+// To compute and return the result as 'hubs' & 'authorities':
+const {hubs, authorities} = hits(graph);
+
+// To directly map the result to nodes' attributes:
+hits.assign(graph);
+
+// Note that you can also pass options to customize the algorithm:
+const {hubs, authorities} = hits(graph, {normalize: false});
+```
+
+_Arguments_
+
+- **graph** _Graph_: target graph.
+- **options** _?object_: options:
+  - **attributes** _?object_: attributes' names:
+    - **weight** _?string_ [`weight`]: name of the edges' weight attribute.
+    - **hub** _?string_ [`hub`]: name of the node attribute holding hub information.
+    - **authority** _?string_ [`authority`]: name of the node attribute holding authority information.
+  - **maxIterations** _?number_ [`100`]: maximum number of iterations to perform.
+  - **normalize** _?boolean_ [`true`]: should the result be normalized by the sum of values.
+  - **tolerance** _?number_ [`1.e-8`]: convergence error tolerance.
+
+### Pagerank
+
+Computes the pagerank metrics for each node.
+
+
+```js
+import pagerank from 'graphology-metrics/centrality/pagerank';
+
+// To compute pagerank and return the score per node:
+const scores = pagerank(graph);
+
+// To directly map the result to nodes' attributes:
+pagerank.assign(graph);
+
+// Note that you can also pass options to customize the algorithm:
+const p = pagerank(graph, {alpha: 0.9, weighted: false});
+```
+
+_Arguments_
+
+- **graph** _Graph_: target graph.
+- **options** _?object_: options:
+  - **attributes** _?object_: attributes' names:
+    - **pagerank** _?string_ [`pagerank`]: name of the node attribute that will be assigned the pagerank score.
+    - **weight** _?string_ [`weight`]: name of the edges' weight attribute.
+  - **alpha** _?number_ [`0.85`]: damping parameter of the algorithm.
+  - **maxIterations** _?number_ [`100`]: maximum number of iterations to perform.
+  - **tolerance** _?number_ [`1.e-6`]: convergence error tolerance.
+  - **weighted** _?boolean_ [`false`]: whether to use available weights or not.
+
 ### Weighted degree
@@ -249,0 +310,0 @@

No alert changes

Improved metrics

Total package byte prevSize

84311

increased by17.1%

Number of package files

39

increased by11.43%

Lines of code

2054

increased by20.12%

Number of lines in readme file

527

increased by13.09%

No dependency changes