Add pagerank references (#423)

Author: tomasonjo

algo/src/main/java/org/neo4j/graphalgo/ShortestPathProc.java

@@ -86,7 +86,7 @@ public Stream<ShortestPathDijkstra.Result> dijkstraStream(
 
     @Procedure(value = "algo.shortestPath", mode = Mode.WRITE)
     @Description("CALL algo.shortestPath(startNode:Node, endNode:Node, weightProperty:String" +
-            "{nodeQuery:'labelName', relationshipQuery:'relationshipName', dirction:'BOTH', defaultValue:1.0, write:'true', writeProperty:'sssp'}) " +
+            "{nodeQuery:'labelName', relationshipQuery:'relationshipName', direction:'BOTH', defaultValue:1.0, write:'true', writeProperty:'sssp'}) " +
             "YIELD nodeId, cost, loadMillis, evalMillis, writeMillis - yields nodeCount, totalCost, loadMillis, evalMillis, writeMillis")
     public Stream<DijkstraResult> dijkstra(
             @Name("startNode") Node startNode,

doc/pagerank.adoc

@@ -33,16 +33,18 @@ It's even used for systems analysis of road networks, as well as biology, chemis
 
 In neuroscience, the PageRank of a neuron in a neural network has been found to correlate with its relative firing rate.
 
-Personalized PageRank is used by Twitter to present users with other accounts they may wish to follow.
+Personalized PageRank is used by Twitter to present users with other accounts they may wish to follow https://web.stanford.edu/class/msande233/handouts/lecture8.pdf[[4\]].
 
 
-PageRank has been used to rank spaces or streets to predict how many people (pedestrians or vehicles) come to the individual spaces or streets. In lexical semantics it has been used to perform Word Sense Disambiguation,Semantic similarity, and also to automatically rank WordNet synsets according to how strongly they possess a given semantic property, such as positivity or negativity.
+PageRank has been used to rank spaces or streets to predict how many people (pedestrians or vehicles) come to the individual spaces or streets. In lexical semantics it has been used to perform Word Sense Disambiguation,Semantic similarity, and also to automatically rank WordNet synsets according to how strongly they possess a given semantic property, such as positivity or negativity http://nmis.isti.cnr.it/sebastiani/Publications/ACL07.pdf[[2\]].
 
-In any ecosystem, a modified version of PageRank may be used to determine species that are essential to the continuing health of the environment.
+In any ecosystem, a modified version of PageRank may be used to determine species that are essential to the continuing health of the environment http://news.bbc.co.uk/2/hi/8238462.stm[[3\]].
 
-For the analysis of protein networks in biology PageRank is also a useful tool.
+For the analysis of protein networks in biology PageRank is also a useful tool https://bmcbioinformatics.biomedcentral.com/track/pdf/10.1186/1471-2105-15-204?site=bmcbioinformatics.biomedcentral.com[[6\]].
 
-Pagerank has recently been used to quantify the scientific impact of researchers. The underlying citation and collaboration networks are used in conjunction with pagerank algorithm in order to come up with a ranking system for individual publications which propagates to individual authors. The new index known as pagerank-index (Pi) is demonstrated to be fairer compared to h-index in the context of many drawbacks exhibited by h-index.
+Pagerank has been used to quantify the scientific impact of researchers http://ilpubs.stanford.edu:8090/422/1/1999-66.pdf[[5\]].
+The underlying citation and collaboration networks are used in conjunction with pagerank algorithm in order to come up with a ranking system for individual publications which propagates to individual authors . 
+The new index known as pagerank-index (Pi) is demonstrated to be fairer compared to h-index in the context of many drawbacks exhibited by h-index.
 
 == Constraints / when not to use it
 
@@ -206,14 +208,22 @@ We support the following versions of the pageRank algorithm:
 
 * http://infolab.stanford.edu/~ullman/mmds/book.pdf
 
-* http://ilpubs.stanford.edu:8090/422/1/1999-66.pdf
-
 * http://www.cs.princeton.edu/~chazelle/courses/BIB/pagerank.htm
 
 * https://anthonybonato.com/2016/04/13/the-mathematics-of-game-of-thrones/
 
 * [1] http://research.ijcaonline.org/volume110/number12/pxc3901035.pdf
 
+* [2] http://nmis.isti.cnr.it/sebastiani/Publications/ACL07.pdf
+
+* [3] http://news.bbc.co.uk/2/hi/8238462.stm
+
+* [4] https://web.stanford.edu/class/msande233/handouts/lecture8.pdf 
+
+* [5] http://ilpubs.stanford.edu:8090/422/1/1999-66.pdf
+
+* [6] https://bmcbioinformatics.biomedcentral.com/track/pdf/10.1186/1471-2105-15-204?site=bmcbioinformatics.biomedcentral.com
+
 ifdef::implementation[]
 // tag::implementation[]
 

doc/single-shortest-path.adoc

@@ -92,7 +92,7 @@ include::scripts/single-shortest-path.cypher[tag=all-pairs-sample-graph]
 [source,cypher]
 ----
 CALL algo.shortestPath(startNode:Node, endNode:Node, weightProperty:String
-{nodeQuery:'labelName', relationshipQuery:'relationshipName', defaultValue:1.0,write:'true',writeProperty:'sssp'})
+{nodeQuery:'labelName', relationshipQuery:'relationshipName', defaultValue:1.0,write:'true',writeProperty:'sssp',direction:'OUTGOING'})
 YIELD nodeCount, totalCost, loadMillis, evalMillis, writeMillis
 
 ----
@@ -109,6 +109,7 @@ YIELD nodeCount, totalCost, loadMillis, evalMillis, writeMillis
 | writeProperty | string | 'sssp' | yes | property name written back to the node sequence of the node in the path
 | nodeQuery | string | null | yes | label to load from the graph, if null load all nodes
 | relationshipQuery | string | null | yes | relationship-type to load from the graph, if null load all nodes
+| direction | string | outgoing | yes | relationship direction to load from the graph, if 'both' treats the relationships as undirected
 |===
 
 .Results
@@ -127,7 +128,7 @@ YIELD nodeCount, totalCost, loadMillis, evalMillis, writeMillis
 [source,cypher]
 ----
 CALL algo.shortestPath.stream(startNode:Node, endNode:Node, weightProperty:String
-{nodeQuery:'labelName', relationshipQuery:'relationshipName', defaultValue:1.0})
+{nodeQuery:'labelName', relationshipQuery:'relationshipName', defaultValue:1.0, direction:'OUTGOING'})
  YIELD nodeId, cost
 ----
 
@@ -141,6 +142,7 @@ CALL algo.shortestPath.stream(startNode:Node, endNode:Node, weightProperty:Strin
 | nodeQuery | string | null | yes | label to load from the graph, if null load all nodes
 | relationshipQuery | string | null | yes | relationship-type to load from the graph, if null load all nodes
 | defaultValue | float | null | yes | default value of the weight in case it is missing or invalid
+| direction | string | outgoing | yes | relationship direction to load from the graph, if 'both' treats the relationships as undirected
 |===
 
 .Results