essence v0.2.0 Essence.Readability

The Readbility module contains several methods for calculating the readability scores of a text.

Summary

Functions

The ari_score method calculates the Automated Readability Index (ARI) of a given Essence.Document

Calculates the Dale-Chall readability score. that provides a numeric gauge of the comprehension difficulty that readers come upon when reading a text. It uses a list of 3000 words that groups of fourth-grade American students could reliably understand, considering any word not on that list to be difficult

Gunning fog index measures the readability of English writing. The index estimates the years of formal education needed to understand the text on a first reading. A fog index of 12 requires the reading level of a U.S. high school senior (around 18 years old). The test was developed by Robert Gunning, an American businessman, in 1952.[1]

Calculates an estimate of the time it would take an average reader to read the given Essence.Document, assuming a reading speed of 200 words per minute

The smog_grade method calculates the SMOG grade measure of readability that estimates the years of education needed to understand a piece of writing. The SMOG grade is commonly used in rating health messages. Please note that results for documents with less than 30 sentences are statistically invalid[1]

Calculates the speaking speed in words per minute, given a speech described by the given Essence.Document and the recorded speaking_time in minutes

Calculates an estimate of the time it would take to read the given Essence.Document as a speech, with a speaking speed of 120 words per minute

Functions

ari_score(document)

The ari_score method calculates the Automated Readability Index (ARI) of a given Essence.Document.

Details

The ARI uses two quantities, mu(w) and mu(s), where mu(w) is average number of letters per word in the given text and mu(s) is the average number of words per sentence in the given text. The ARI is then defined by the following formula: ari = 4.71 * mu(w) + 0.5 * mu(s) - 21.43

Commonly, the ARI score is rounded up and translated by the following table:

ARI scoreReadability LevelReader Age
1Kindergarten5-6
2First Grade6-7
3Second Grade7-8
4Third Grade8-9
5Fourth Grade9-10
6Fifth Grade10-11
7Sixth Grade11-12
8Seventh Grade12-13
9Eighth Grade13-14
10Ninth Grade14-15
11Tenth Grade15-16
12Eleventh Grade16-17
13Twelth Grade17-18
14+College18-22
dale_chall(document)

Calculates the Dale-Chall readability score. that provides a numeric gauge of the comprehension difficulty that readers come upon when reading a text. It uses a list of 3000 words that groups of fourth-grade American students could reliably understand, considering any word not on that list to be difficult.

ScoreNotes
4.9 or lowereasily understood by an average 4th-grade student or lower
5.0–5.9easily understood by an average 5th or 6th-grade student
6.0–6.9easily understood by an average 7th or 8th-grade student
7.0–7.9easily understood by an average 9th or 10th-grade student
8.0–8.9easily understood by an average 11th or 12th-grade student
9.0–9.9easily understood by an average 13th to 15th-grade (college) student
gunning_fog(document)

Gunning fog index measures the readability of English writing. The index estimates the years of formal education needed to understand the text on a first reading. A fog index of 12 requires the reading level of a U.S. high school senior (around 18 years old). The test was developed by Robert Gunning, an American businessman, in 1952.[1]

The fog index is commonly used to confirm that text can be read easily by the intended audience. Texts for a wide audience generally need a fog index less than 12. Texts requiring near-universal understanding generally need an index less than 8.

[1] DuBay, William H. (23 March 2004). “Judges Scold Lawyers for Bad Writing”. Plain Language At Work Newsletter. Impact Information (8).

Fog IndexReading level by grade
17College graduate
16College senior
15College junior
14College sophomore
13College freshman
12High school senior
11High school junior
10High school sophomore
9High school freshman
8Eighth grade
7Seventh grade
6Sixth grade
reading_time(document, speed \\ 200)

Calculates an estimate of the time it would take an average reader to read the given Essence.Document, assuming a reading speed of 200 words per minute.

smog_grade(document)

The smog_grade method calculates the SMOG grade measure of readability that estimates the years of education needed to understand a piece of writing. The SMOG grade is commonly used in rating health messages. Please note that results for documents with less than 30 sentences are statistically invalid[1].

[1] https://en.wikipedia.org/wiki/SMOG

speaking_speed(document, speaking_time)

Calculates the speaking speed in words per minute, given a speech described by the given Essence.Document and the recorded speaking_time in minutes.

speaking_time(document, speed \\ 120)

Calculates an estimate of the time it would take to read the given Essence.Document as a speech, with a speaking speed of 120 words per minute.