Tools.ScatterPlot()

new ScatterPlot()

ScatterPlot is a graph visualization of how words cluster in a corpus document similarity, correspondence analysis or principal component analysis.

Tutorials:
Example
let config = {
    "analysis": null,
    "bins": null,
    "clusters": null,
    "comparisonType": null,
    "dimensions": null,
    "docId": null,
    "iterations": null,
    "label": null,
    "limit": null,
    "perplexity": null,
    "query": null,
    "stopList": null,
    "storeJson": null,
    "target": null,
    "term": null,
    "whitelist": null,
  };

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

Members

analysis

Properties:
Name Type Description
analysis String

The type of analysis to perform. Options are: 'ca', 'pca', 'tsne', and 'docSim'.

bins

Properties:
Name Type Default Description
bins Number 10

The number of "bins" to divide the result into.

clusters

Properties:
Name Type Default Description
clusters Number 3

The number of clusters within which to group words.

comparisonType

Properties:
Name Type Default Description
comparisonType String relative

The value to use for comparing terms. Options are: 'raw', 'relative', and 'tfidf'.

dimensions

Properties:
Name Type Default Description
dimensions Number 3

The number of dimensions to render, either 2 or 3.

docId

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

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

iterations

Properties:
Name Type Default Description
iterations Number 1500

The TSNE iterations value.

label

Properties:
Name Type Description
label Array.<String>

The label types to show. One or more of: 'summary', 'docs', and 'terms'.

limit

Properties:
Name Type Default Description
limit Number 50

The number of items to limit the result to.

perplexity

Properties:
Name Type Default Description
perplexity Number 15

The TSNE perplexity value.

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.

storeJson

Properties:
Name Type Description
storeJson String

TODO used in embed

target

Properties:
Name Type Description
target String

The term to set as the target. This will filter results to terms that are near the target.

term

Properties:
Name Type Description
term Array.<String>

Used in combination with "target" as a white list of terms to keep.

whitelist

Properties:
Name Type Description
whitelist String

TODO Unused or only used in CA?