readinglevel

README

readinglevel
===============

ReadingLevel is a Go package for determining the reading level of a passage of text. It currently provides the Flesch–Kincaid Grade Level, the Flesch-Kincaid Reading Ease, the Coleman–Liau index, the Gunning fog index, the SMOG (Simple Measure of Gobbledygook), and the Automated Readabilty Index.




### License

ReadingLevel is free software licensed under the MIT/X11 license. Details provided in the LICENSE file.

Documentation

Index

• func ARI(corpus string) float64
• func ColemanLiau(corpus string) float64
• func FleschKincaidEase(corpus string) (float64, error)
• func FleschKincaidGrade(corpus string) (float64, error)
• func GunningFog(corpus string) (float64, error)
• func NumCharacters(corpus string) int
• func NumComplexWords(text string) (int, error)
• func NumSentences(corpus string) int
• func NumSyllables(text string) (int, error)
• func NumWords(corpus string) int
• func SMOG(corpus string) (float64, error)

Functions

func ARI

func ARI(corpus string) float64

ARI returns the readability score according to the Automated Readability Index

func ColemanLiau

func ColemanLiau(corpus string) float64

func FleschKincaidEase

func FleschKincaidEase(corpus string) (float64, error)

FleschKincaidEase returns the reading ease score of the given body of text according to the Flesch-Kincaid reading ease test It overestimates the reading ease score slightly, as unknown words are treated as having 0 syllables

func FleschKincaidGrade

func FleschKincaidGrade(corpus string) (float64, error)

FleschKincaidGrade returns the grade level of the given body of text according to the Flesch-Kincaid grade level test It underestimates the grade level slightly, as unknown words are treated as having 0 syllables

func GunningFog

func GunningFog(corpus string) (float64, error)

GunningFog returns the readability index according to the Gunning fog index

func NumCharacters

func NumCharacters(corpus string) int

func NumComplexWords

func NumComplexWords(text string) (int, error)

func NumSentences

func NumSentences(corpus string) int

func NumSyllables

func NumSyllables(text string) (int, error)

func NumWords

func NumWords(corpus string) int

func SMOG

func SMOG(corpus string) (float64, error)

SMOG returns the readability score according to SMOG (Simple Measure of Gobbledygook