Contents
  1. Overview
  2. Options
  3. Spyral
  4. Additional Information
  5. See Also

Reader

The Reader tool provides a way of reading documents in the corpus, text is fetched as needed.

Use it with a Jane Austen corpus or with your own corpus.

Overview

The Reader tool is composed of two visual components: the Text Reader and the Prospect Viewer.

Text Reader

This is where text is displayed for reading. The formatting will be minimal, limited especially to line breaks (depending on the format of the source document). With the text reader you can:

  • scroll down within the text reader to fetch more content
  • hover over a word to show its frequency in the document
  • click on a word to search for it in the Reader (and other tools if applicable)

Prospect Viewer

This shows an overview of the entire corpus, especially useful when there are multiple documents in a corpus. The bars represent each document in the order they appear in the corpus. The relative length of the document is represented both vertically and horizontally (in other words, the taller and wider a document is shown, the longer it is).

When there's a search term, an inner sparkline is shown overtop of the bars – this shows the relative frequency of terms (by default each document is broken into segments of 25 equal parts for the sparkline).

There's also a thin vertical blue bar that indicates the current position of the Text Reader in the corpus. You can click anywhere along the Prospect Viewer to jump to another location.

Reader with the Works of Jane Austen. You can also use Reader with your own corpus.

Options

You can use the arrows to go forward or backward in the text. By default jumps are made in increments of about 1,000 words.

You can specify terms by typing a query into the search box and hitting enter (see Search for more advanced searching capabilities).

Spyral

To use Reader widget in Spyral you can use the following code as a starting point. Modify the config object to modify the visualization.

let config = {
    "limit": null,
    "query": null,
    "skipTodocId": null,
    "start": null
}; 

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

Please see Tools.Reader for more information about configuration.

Additional Information

The Prospect Viewer is inspired by the work of Stan Ruecker (see this book or this video).

See Also