kRp.readability-class function

S4 Class kRp.readability

S4 Class kRp.readability

This class is used for objects that are returned by readability and its wrapper functions (e.g., Flesch, FOG or LIX). class

Slots

  • lang: A character string, naming the language that is assumed for the text in this object.

  • tokens: The tokenized and POS-tagged text. See kRp.text for details.

  • desc: Descriptive measures which were computed from the text:

     - **`sentences`:**: Number of sentences.
 - **`words`:**: Number of words.
 - **`letters`:**: Named vector with total number of letters (`"all"`) and possibly several entries called `"l<digit>"`, giving the number of words with `<digit>` letters.
 - **`all.chars`:**: Number of all characters, including spaces.
 - **`syllables`:**: Named vector with the number of syllables, simlar to `letters`, but entries are called `"s<digit>"` (`NA` if hyphenation was skipped).
 - **`lttr.distrib`:**: Distribution of letters: Absolute numbers, cumulative sum, inversed cumulative sum, percent, cumulative percent, and inversed cumulative percent.
 - **`syll.distrib`:**: Distribution of syllables (see `lttr.distrib`, `NA` if hyphenation was skipped).
 - **`syll.uniq.distrib`:**: Distribution of unique syllables (see `lttr.distrib`, `NA` if hyphenation was skipped).
 - **`punct`:**: Number of punctuation characters.
 - **`conjunctions`:**: Number of conjunctions.
 - **`prepositions`:**: Number of prepositions.
 - **`pronouns`:**: Number of pronouns.
 - **`foreign`:**: Number of foreign words.
 - **`TTR`:**: Type-token ratio.
 - **`avg.sentc.length`:**: Average number of words per sentence.
 - **`avg.word.length`:**: Average number of characters per word.
 - **`avg.syll.word`:**: Average number of syllables per word (`NA` if hyphenation was skipped).
 - **`sntc.per.word`:**: Number of sentences per word.
 - **`sntc.per100`:**: Number of sentences per 100 words.
 - **`lett.per100`:**: Number of letters per 100 words.
 - **`syll.per100`:**: Number of syllables per 100 words (`NA` if hyphenation was skipped).
 - **`FOG.hard.words`:**: Number of hard words, counted according to FOG (`NULL` if measure was not computed).
 - **`Bormuth.NOL`:**: Number of words not on the Bormuth word list (`NULL` if measure was not computed).
 - **`Dale.Chall.NOL`:**: Number of words not on the Dale-Chall word list (`NULL` if measure was not computed).
 - **`Harris.Jacobson.NOL`:**: Number of words not on the Harris-Jacobson word list (`NULL` if measure was not computed).
 - **`Spache.NOL`:**: Number of words not on the Spache word list (`NULL` if measure was not computed).

  • hyphen: The hyphenated text that was actually analyzed (i.e. without certain word classes, if they were to be removed).

  • param: Relevant parameters of the given analysis, as given to the function call. See readability

     for detailed onformation.

  • ARI: The "flavour" of the parameter settings and the calculated value of the ARI level. NA if not calculated.

  • ARI.NRI: See "ARI".

  • ARI.simple: See "ARI".

  • Bormuth: The "flavour" of the parameter settings and the calculated value of Bormuth's Mean Cloze and grade level. NA if not calculated.

  • Coleman: The "flavour" of the parameter settings and the calculated value of the four Coleman formulas. NA if not calculated.

  • Coleman.Liau: The "flavour" of the parameter settings and the calculated value of the Coleman-Liau index. NA if not calculated.

  • Dale.Chall: The "flavour" of the parameter settings and the calculated value of the Dale-Chall Readability Formula. NA if not calculated.

  • Dale.Chall.PSK: See "Dale.Chall".

  • Dale.Chall.old: See "Dale.Chall".

  • Danielson.Bryan: The "flavour" of the parameter settings and the calculated value of the Danielson-Bryan Formula. NA if not calculated.

  • Dickes.Steiwer: The "flavour" of the parameter settings and the calculated value of Dickes-Steiwer's shortcut formula. NA if not calculated.

  • DRP: The "flavour" of the parameter settings and the calculated value of the Degrees of Reading Power. NA if not calculated.

  • ELF: The "flavour" of the parameter settings and the calculated value of the Easy Listening Formula. NA if not calculated.

  • Farr.Jenkins.Paterson: The "flavour" of the parameter settings and the calculated value of the Farr-Jenkins-Paterson index. NA if not calculated.

  • Farr.Jenkins.Paterson.PSK: See "Farr.Jenkins.Paterson".

  • Flesch: The "flavour" of the parameter settings and the calculated value of Flesch Reading Ease. NA if not calculated.

  • Flesch.PSK: See "Flesch".

  • Flesch.Brouwer: See "Flesch".

  • Flesch.Szigriszt: See "Flesch".

  • Flesch.de: See "Flesch".

  • Flesch.es: See "Flesch".

  • Flesch.fr: See "Flesch".

  • Flesch.nl: See "Flesch".

  • Flesch.Kincaid: The "flavour" of the parameter settings and the calculated value of the Flesch-Kincaid Grade Level. NA if not calculated.

  • FOG: The "flavour" of the parameter settings, a list of proper nouns, combined words and verbs that were not counted as hard words ("dropped"), the considered number of hard words, and the calculated value of Gunning's FOG index. NA if not calculated.

  • FOG.PSK: See "FOG".

  • FOG.NRI: See "FOG".

  • FORCAST: The "flavour" of the parameter settings and the calculated value of the FORCAST grade level. NA if not calculated.

  • FORCAST.RGL: See "FORCAST".

  • Fucks: The calculated value of Fucks' Stilcharakteristik. NA if not calculated.

  • Gutierrez: The "flavour" of the parameter settings and the calculated value of the Gutierrez index. NA if not calculated.

  • Harris.Jacobson: The "flavour" of the parameter settings and the calculated value of the Harris-Jacobson index. the word list used, all words not found on the list, the percentage of difficult words, the percentage of long words, as well as HJ1 to HJ5 for the five indices. NA if not calculated.

  • Linsear.Write: The "flavour" of the parameter settings and the calculated value of the Linsear Write index. NA if not calculated.

  • LIX: The "flavour" of the parameter settings and the calculated value of the LIX index. NA if not calculated.

  • RIX: The "flavour" of the parameter settings and the calculated value of the RIX index. NA if not calculated.

  • SMOG: The "flavour" of the parameter settings and the calculated value of the SMOG grade level. NA if not calculated.

  • SMOG.de: See "SMOG".

  • SMOG.C: See "SMOG".

  • SMOG.simple: See "SMOG".

  • Spache: The "flavour" of the parameter settings and the calculated value of the Spache formula. NA if not calculated.

  • Spache.old: See "Spache".

  • Strain: The "flavour" of the parameter settings and the calculated value of the Strain index. NA if not calculated.

  • Traenkle.Bailer: The "flavour" of the parameter settings, percentages of prepositions and conjunctions, and the calculated values of both Tr"ankle-Bailer formulae. NA if not calculated.

  • TRI: The calculated value of Kuntzsch' Text-Redundanz-Index. NA if not calculated.

  • Tuldava: The calculated value of the Tuldava text difficulty formula. NA if not calculated.

  • Wheeler.Smith: The "flavour" of the parameter settings and the calculated value of the Wheeler-Smith index. NA if not calculated.

  • Wheeler.Smith.de: See "Wheeler.Smith"

  • Wiener.STF: The "flavour" of the parameter settings and the calculated value of the Wiener Sachtextformel. NA if not calculated.

Contructor function

Should you need to manually generate objects of this class (which should rarely be the case), the contructor function kRp_readability(...) can be used instead of new("kRp.readability", ...).

koRpus packageRead PDF manual
  • Maintainer: Meik Michalke
  • License: GPL (>= 3)
  • Last published: 2021-05-17

Useful links