Skip to content

Commit

Permalink
try new image relative link
Browse files Browse the repository at this point in the history
  • Loading branch information
sfritzell authored Jul 27, 2023
1 parent 4e10151 commit b3648ac
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions topics/4-defaults.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Let's explore a few of the default tools included with Voyant and some of the op

A word cloud showing the most frequently occuring words in the corpus or document. Hovering above a term will display its frequency.

![Screenshot of the Cirrus tool.]({{ site.baseurl }}/assets/Voyant-Cirrus-Hover.png)
![Screenshot of the Cirrus tool.](../assets/Voyant-Cirrus-Hover.png)

Cirrus has a slider near the bottom (with the label "scale") that allows you to adjust the number of words displayed by increments of 25. By default the minimum value allowed is 25 and the maximum value is 500.

Expand All @@ -28,19 +28,19 @@ A corpus reader that fetches segments of text as you scroll.

The Reader tool has two components. The first is the Text Reader, where text is displayed for reading with minimal formatting. Scrolling will enable you to fetch more content, hovering over a word will display its frequency within the document (*not* within the corpus), and clicking on a term will search for it within the Reader and in other tools if applicable.

![Screenshot of the Text Reader component.]({{ site.baseurl }}/assets/Voyant-Reader-Text.png)
![Screenshot of the Text Reader component.](../assets/Voyant-Reader-Text.png)

The second componenet of the Reader tool is the Prospect Reader, which looks like a series of colored boxes below the Text Reader. The Prospect Viewer provides an overview of the entire corpus, which is particularly useful if your corpus consists of multiple documents, like ours does! The bars represent each document in the order they appear in the corpus, and the relative length of each document is represented both the height and width of the bar. A verticle blue bar will indicate the current position of the Text Reader in the corpus as you browse. You can click anywhere along the Prospect Viwer to jump to that point in the text.

![Screenshot of the Prospect Reader component.]({{ site.baseurl }}/assets/Voyant-Reader-Prospects.png)
![Screenshot of the Prospect Reader component.](../assets/Voyant-Reader-Prospects.png)

You can specify search terms either by clicking on works in the Text Reader, or entering them into the query box at the bottom of the tool. When a search term is entered, a sparkline will appear within the bars of the Prospect Reader showing the relative frequency of that term accross the corpus.

### 3. Trends

A distribution graph displaying the frequency of terms accross documents in a corpus (or segements in a document).

![Screenshot of the Trends tool.]({{ site.baseurl }}/assets/Voyant-Trends.png)
![Screenshot of the Trends tool.](../assets/Voyant-Trends.png)

Each series in the graph is coloured according to the word it represents. A legend at the top of the graph displays which words are associated with which colors. Clicking on words in the legend will affect their visibility in the graph. Hovering over any point in the graph activates a popup with information about that point, including the word, its frequency, and the document or document segment. For corpora consisting of multiple documents, like ours, double-clicking on a point allows you to "drill down" or view the frequency of that word accross a single document within the corpus.

Expand All @@ -54,7 +54,7 @@ Clicking on the "reset" button at the bottom of this tool will return you to the

Provides a simple, textual overview of the current corpus, including the total word count, number of unique words, longest and shortest documents, the highest and lowest vocabulary density, average number of words per sentence, the most frequent words, notable peaks in word frequency, and distincitve words accross each document in the corpus.

![Screenshot of the Summary tool.]({{ site.baseurl }}/assets/Voyant-Summary.png)
![Screenshot of the Summary tool.](../assets/Voyant-Summary.png)

### 5. Contexts

Expand All @@ -69,7 +69,7 @@ By default, this tool takes the appearnace of a table with four columns:

By clicking on the caret at the top of any column you can choose to add an additional column called "position" to the table, which displays the position (token index) of the term in the document.

![Screenshot of Contexts tool.]({{ site.baseurl }}/assets/Voyant-Contexts.png)
![Screenshot of Contexts tool.](../assets/Voyant-Contexts.png)

Use the search box at the bottom of the tool panel to specify which keyword to use with this tool. You can also use the "context" slider to specify how many words to consider as context on either side of the keyword, or the "expand" slider to specify how many words to display when you expand a given row.

Expand Down

0 comments on commit b3648ac

Please sign in to comment.