coleman-liau
v2.0.1
Published
Formula to detect the ease of reading a text according to the Coleman-Liau index (1975)
Downloads
12,303
Readme
coleman-liau
Formula to detect the ease of reading a text according to the Coleman-Liau index.
Contents
What is this?
This package exposes an algorithm to detect ease of reading of English texts.
When should I use this?
You’re probably dealing with natural language, and know you need this, if you’re here!
This algorithm isn’t based on syllabbles compared to some other algorithms, which means it’s quicker to calculate.
Install
This package is ESM only. In Node.js (version 14.14+, 16.0+), install with npm:
npm install coleman-liau
In Deno with esm.sh
:
import {colemanLiau} from 'https://esm.sh/coleman-liau@2'
In browsers with esm.sh
:
<script type="module">
import {colemanLiau} from 'https://esm.sh/coleman-liau@2?bundle'
</script>
Use
import {colemanLiau} from 'coleman-liau'
// For:
//
// Existing computer programs that measure readability are based largely upon
// subroutines which estimate number of syllables, usually by counting vowels.
// The shortcoming in estimating syllables is that it necessitates keypunching
// the prose into the computer.
// There is no need to estimate syllables since word length in letters is a
// better predictor of readability than word length in syllables.
// Therefore, a new readability formula was computed that has for its predictors
// letters per 100 words and sentences per 100 words.
// Both predictors can be counted by an optical scanning device, and thus the
// formula makes it economically feasible for an organization such as the U.S.
// Office of Education to calibrate the readability of all textbooks for the
// public school system.
//
// Containing 5 sentences, 119 words, and 639 letters or digits.
colemanLiau({sentence: 5, word: 119, letter: 639}) // => 14.53042…
API
This package exports the identifier colemanLiau
.
There is no default export.
colemanLiau(counts)
Given an object containing the number of words (word
), the number of sentences
(sentence
), and the number of letters (letter
) in a document, returns the
grade level associated with the document.
counts
Counts from input document.
counts.sentence
Number of sentences (number
, required).
counts.word
Number of words (number
, required).
counts.letter
Number of letters (number
, required).
Returns
Grade level associated with the document (number
).
Types
This package is fully typed with TypeScript.
It exports the additional type Counts
.
Compatibility
This package is at least compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.0+. It also works in Deno and modern browsers.
Related
automated-readability
— uses character count instead of error-prone syllable parserdale-chall-formula
— uses a dictionary, suited for higher reading levelsflesch
— uses syllable countflesch-kincaid
— likeflesch-formula
, returns U.S. grade levelsgunning-fog
— uses syllable count, hard to implement with a computer (needs POS-tagging and Named Entity Recognition)smog-formula
— likegunning-fog
, without needing advanced NLPspache-formula
— uses a dictionary, suited for lower reading levels
Contribute
Yes please! See How to Contribute to Open Source.
Security
This package is safe.