Tools.WordTree()

new WordTree()

The Word Tree tool allows you to explore how keywords are used in different phrases in the corpus.

Tutorials:
Example
let config = {
    "context": null,
    "docId": null,
    "docIndex": null,
    "limit": null,
    "query": null,
    "stopList": null
  };

  loadCorpus("austen").tool("wordtree", config);

Members

context

Properties:
Name Type Default Description
context Number 10

The number of terms to consider on each side of the keyword.

docId

Properties:
Name Type Description
docId String | Array.<String>

The document ID(s) to restrict the results to.

docIndex

Properties:
Name Type Description
docIndex Number | Array.<Number>

The document index(es) to restrict the results to.

limit

Properties:
Name Type Default Description
limit Number 100

The number of items to limit the result to.

query

Properties:
Name Type Description
query String | Array.<String>

A query or array of queries (queries can be separated by a comma). For query syntax, see the search documentation.

stopList

Properties:
Name Type Default Description
stopList String auto

A comma-separated list of words, a named list or a URL to a plain text list, one word per line. By default this is set to 'auto' which auto-detects the document's language and loads an appropriate list (if available for that language). Set this to blank to not use the default stopList. For more information see the Stopwords documentation.