Default Output

The Options Object

The options object is optional and provides a number of controls to allow you to tailor the output to your needs. However, for general use it is recommended that all options are left to their defaults.

$3

String - valid options: 'binary' (default), 'freq', or 'percent

Controls how the lexical value is calculated. You probably shouldn't change this!

Binary is simply the addition of lexical weights, i.e. word1 + word2 + word3.

Frequency encoding takes the overall wordcount and word frequency into account, i.e. (word frequency / word count) * weight.

Percent returns the percentage of token matches in each category as a decimal, i.e. 0.48 - 48%.

$3

Float

Exclude words that have weights above the max threshold or below the min threshold.

By default these are set to infinity, ensuring that no words from the lexicon are excluded.

$3

Array - [2, 3] (default)

n-Grams are contiguous pieces of text, bi-grams being chunks of 2, tri-grams being chunks of 3, etc.

[2, 3] the default option, means "include bi-grams and trigrams", if you only wanted to inclue bi-grams for example, you would use [2].

Use the nGrams option to control the n-gram lengths included. For accuracy it is recommended that n-grams are set to the default of [2, 3], however including n-grams for very long strings can detrement performance.

$3

$3

$3

String - valid options: 'lex' (default), 'matches', 'full'

'lex' (default) returns an object with O,C,E,A,N keys and lexical value properties - see 'default output example' above.

'matches' returns an object with O,C,E,A,N keys, each with an array of lexical match information within. See 'matches output example' below.

'full' returns both of the above in one object with two keys, 'values' and 'matches'. 'values' = the 'ocean' object above. 'matches' = the matches object above.

$3

Number

Number of decimal places to limit outputted values to.

The default is 9 decimal places.

$3

String - valid options: 'freq' (default), 'weight', or 'lex'

If 'output' = 'matches', this option can be used to control how the outputted array is sorted.

'lex' (default) sorts by final lexical value, (N.B. when using binary encoding [see 'encoding' above] the lexical value and the weight are identical).

'weight' sorts the array by the matched words initial weight.

'freq' sorts by word frequency, i.e. the most used words appear first.

$3

String - valid options: 'true' or 'false' (default)

When set to true, the output from the nGrams option will be added to the word count.

For accuracy it is recommended that this is set to false.

{output: 'matches'} output example