new Summary()
The Summary panel provides an overview of a corpus, and the content will depend on whether the corpus includes one document or many.
- Tutorials:
Example
let config = {
"limit": null,
"numberOfDocumentsForDistinctiveWords": null,
"start": null,
"stopList": null,
};
loadCorpus("austen").tool("Summary", config);
Members
-
limit
-
Properties:
Name Type Default Description limit
Number 5 The number of items to limit the result to.
-
numberOfDocumentsForDistinctiveWords
-
Properties:
Name Type Description numberOfDocumentsForDistinctiveWords
Number The number of items to include in the list of distinctive words (similar to the limit parameter but specific to distinctive words).
-
start
-
Properties:
Name Type Default Description start
Number 0 The index of the item to start the results at.
-
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.