@graphty/graphty-element / session / defaultReading
Function: defaultReading() ​
defaultReading(
result,options):string
Defined in: graphty-element/src/session/results/reading.ts:300
Write one sentence saying what a result means.
ONE SENTENCE PER SHAPE, not per algorithm. What a reader needs to hear about a measurement is the same whether the measurement was degree or betweenness -- which is the same reason the field NAMES are fixed by the shape rather than by the algorithm. An algorithm that wants to say something only it can say publishes a field and the sentence picks it up, as modularity is picked up for a partition that scores itself.
Every figure in the sentence comes from the result. Nothing is rounded to make a phrase read better, no comparison is drawn that the numbers do not support, and a shape with nothing to say falls back to how much of the graph the run covered rather than inventing a finding.
Parameters ​
result ​
The result to read.
options ​
The locale to print numbers in, and whether to use plain or technical words.
Returns ​
string
The sentence.