API

Readability.ari — Function

ari(text::String)::Int

Returns the Automated Readability Index (ARI) of text.

Argument

text::String: The text to analyze.

Returns

Int: The ARI score.

Reference

source

Readability.characters — Function

characters(text::String)::Int

Returns the number of characters in text.

source

Readability.characters_per_word — Function

characters_per_word(text::String)::Number

Returns the number of characters per word or the average word length in text.

source

Readability.coleman_liau — Function

coleman_liau(text::String)::Number

Returns the Coleman-Liau Index of text.

CLI = 0.0588 * L - 0.296 * S - 15.8

L = number of characters per 100 words

S = number of sentences per 100 words

Argument

text::String: The text to analyze.

Returns

Number: The Coleman-Liau Index.

source

Readability.complex_words — Function

complex_words(text::String)::Int

Returns the number of complex words (words with 3 or more syllables and not ending in "es", "ed", or "ing") in text.

source

Readability.dale_chall — Function

dale_chall(text::String)::Number

Returns the Dale-Chall readability score of text.

source

Readability.difficult_words — Function

difficult_words(text::String, word_list::String)::Int

Returns the number of words that are not in the specified word_list (either "dale-chall" or "spache") in text.

source

Readability.flesch_kincaid_grade_level — Function

flesch_kincaid_grade_level(text::String)::Float64

Returns the Flesch-Kincaid grade level of text.

source

Readability.flesch_reading_ease_score — Function

flesch_reading_ease_score(text::String)::Float64

Returns the Flesch Reading Ease Score of text.

source

Readability.gunning_fog — Function

gunning_fog(text::String)::Number

Returns the Gunning Fog index of text.

source

Readability.lines — Function

lines(text::String)::Int

Returns the number of lines text.

source

Readability.paragraphs — Function

paragraphs(text::String)::Int

Returns the number of paragraphs in text.

source

Readability.polysyllabic_words — Function

polysyllabic_words(text::String)::Int

Returns the number of words with 3 or more syllables in text.

source

Readability.reading_time — Function

reading_time(text::String; wpm::Number=238)::Float64

Returns the reading time of text in seconds.

Arguments

text::String: The text to analyze.
wpm::Number: The words per minute.

Returns

Float64: The reading time in seconds.

source

Readability.sentences — Function

sentences(text::String)::Int

Returns the number of sentences in text.

source

Readability.sentences_per_paragraph — Function

sentences_per_paragraph(text::String)::Number

Returns the number of sentences per paragraph or the average paragraph length in text.

source

Readability.smog — Function

smog(text::String)::Number

Returns the SMOG Index of text.

source

Readability.spache — Function

spache(text::String)::Number

Returns the Spache readability score of text.

source

Readability.speaking_time — Function

speaking_time(text::String; wpm::Number=183)::Float64

Returns the speaking time of text in seconds.

Arguments

text::String: The text to analyze.
wpm::Number: The words per minute.

Returns

Float64: The speaking time in seconds.

source

Readability.syllables — Function

syllables(text::String)::Int

Returns the number of syllables in text.

source

Readability.syllables_per_word — Function

syllables_per_word(text::String)::Number

Returns the number of syllables per word or the average word length in text.

source

Readability.words — Function

words(text::String)::Int

Returns the number of words in text.

source

Readability.words_per_sentence — Function

words_per_sentence(text::String)::Number

Returns the number of words per sentence or the sentence length in text.

source