NAME
Lingua::EN::Fathom - provide readability and general text measurements
SYNOPSIS
use Lingua::EN::Fathom;
my $text = new Lingua::EN::Fathom;
$text->analyse_file("sample.txt");
$text->analyse_block($text_string);
$num_chars = $text->num_chars;
$num_words = $text->num_words;
$num_sentences = $text->num_sentences;
$num_text_lines = $text->num_text_lines;
$num_blank_lines = $text->num_blank_lines;
%words = $text->unique_words;
foreach $word ( sort keys %words )
{
print("$words{$word} :$word\n");
}
$fog = $text->fog;
$flesch = $text->flesch;
$kincaid = $text->kincaid;
print($text->report);
REQUIRES
Perl, version 5.001 or higher, Lingua::EN::Syllable
DESCRIPTION
This module analyses English text in either a string or file. Totals are then calculated for the number of characeters, words, sentences, blank and onon blank (text) lines.
Three common readablity statistics are also derived, the Fog, Flesch and Kincaid indices.
All of these properties can ve accessed through individual methods, or by generatring a text report.
METHODS
new
The new method creates an instance of an text object This must be called before any of the following methods are invoked. Note that the object only needs to be created once, and can be reused with new input data.
my $text = new Lingua::EN::Fathom; analyse_file
The analyse_file method takes as input the name of a text file. Various text based statistics are calculated for the file. This method and analyse_block are prerequisites for all the following methods.
analyse_block
The analyse_block method takes as input the name of a text file. Various text based statistics are calculated for the file. This method and analyse_file are prerequisites for all the following methods.
num_chars
Returns the number of characters in the analysed text file or block. This includes characters such as spaces, and punctuation marks.
num_words
Returns the number of words in the analysed text file or block. A word must consist of letters a-z with at least one vowel sound, and optionally an apostrophe or hyphen. Items such as "&, K108, NSW" are not counted as words.
num_sentences
Returns the number of sentences in the analysed text file or block. A sentence is any group of words and non words terminated with a single full stop. Spaces may occur before and after the full stop.
num_text_lines
Returns the number of lines containing some text in the analysed text file or block.
num_blank_lines
Returns the number of lines NOT containing any text in the analysed text file or block.
fog
Returns the Fog index for the analysed text file or block.
The Fog index, developed by Robert Gunning, is a well known and simple formula for measuring readability. The index indicates the number of years of formal education a reader of average intellegence would need to read the text once and understand that piece of writing with its word sentence workload.
18 unreadable
14 difficult
12 ideal
10 acceptable
8 childishflesch
Returns the Flesch reading ease score for the analysed text file or block.
This score rates text on a 100 point scale. The higher the score, the easier it is to understand the text. A score of 60 to 70 is considered to be optimal.
kincaid
Returns the Flesch-Kincaid grade level score for the analysed text file or block.
This score rates text on U.S. grade school level. So a score of 8.0 means that the document can be understood by an eighth grader. A score of 7.0 to 8.0 is considered to be optimal.
unique_words
Returns a hash of unique words. The word itself (in lower case)is held in the hash key while the number of occurrences is held in the hash value.
LIMITATIONS
SEE ALSO
B::Fathom
POSSIBLE EXTENSIONS
Analyse many files at once
Analyse HTML and other formats
Count paragraphs
Allow user control over what strictly defines a word
Provide a density measure of white space to characters BUGS
CHANGES
0.01 23 Jan 2000: First Release
COPYRIGHT
Copyright (c) 2000 Kim Ryan. All rights reserved. This program is free software; you can redistribute it and/or modify it under the terms of the Perl Artistic License (see http://www.perl.com/perl/misc/Artistic.html).
AUTHOR
Fathom was written by Kim Ryan <kimaryan@ozemail.com.au> in 2000.