Text Statistics Help

Name:	Text Statistics
Version:	0.1
Last update:	2020-05-27 14:28:41

This package provides functions to gather statistics about the text contained in a document window. It inserts a new submenu named Text Statistics in the Tools menu. The commands are explained below.

Menu Items

Word count: get the line count, the word count, the character count and the average number of characters per word.
Sentence count: get the sentence count, the average character length and the average number of words per sentence.
Frequently used words: list the most used words in the text. See the Frequent Words Limit preference below.
Frequently used expressions: list the most used expressions of 2, 3, 4 or 5 words. See the Frequent Expressions Limit preference below. The expressions are searched within the sentences.
Count occurrences: count the number of occurrences of a string in the document. It is possible to search a regular expression.

All these commands apply to the frontmost document window. They display their results in a single results window.
The Options submenu lets you toggle rapidly the Case Sensitive Frequency and Right Align Fields preferences. See the Preferences section below.

Preferences

Using the menu item Tools ↣ Text Statistics ↣ Show Preferences... (or alternatively Alpha ↣ Preferences ↣ Package Preferences ↣ Text Statistics), one can set some default values for the different parameters, like for instance the comparison criterion. Click here to display the Text Statistics Preferences panel. Here is the description of the aivalable preferences:

Case Sensitive Frequency: The Case Sensitive Frequency flag tells whether the commands looking for the most used word or expression frequencies take the case into account. The default value is 1.
Right Align Fields: The Right Align Fields flag tells whether the fields should be right aligned in the result window. The default value is 0.
Frequent Words Limit: The Frequent Words Limit preference sets the default maximum number of frequent words to display. The default value is 30.
Frequent Expressions Limit: The Frequent Expressions Limit preference sets the default maximum number of frequent expressions to display. The default value is 20.

Known problems

Please report any problem or bug you encounter to Alpha's Bug Tracker.

License and Disclaimer

Copyright (c) 2018-2020, Bernard Desgraupes.
All rights reserved.
The Text Statistics package is free software and distributed under the terms of the new BSD license:
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of Bernard Desgraupes nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BERNARD DESGRAUPES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.