spache: Readability: Spache Formula

Description Usage Arguments Details Value Examples

View source: R/wrapper_functions_readability.R

Description

This is just a convenient wrapper function for readability.

Usage

1
2
3
4
5
6
spache(
  txt.file,
  word.list,
  parameters = c(asl = 0.121, dword = 0.082, const = 0.659),
  ...
)

Arguments

txt.file

Either an object of class kRp.text, a character vector which must be be a valid path to a file containing the text to be analyzed, or a list of text features. If the latter, calculation is done by readability.num.

word.list

A vector or matrix (with exactly one column) which defines familiar words. For valid results the short Dale-Chall list with 769 easy words should be used.

parameters

A numeric vector with named magic numbers, defining the relevant parameters for the index.

...

Further valid options for the main function, see readability for details.

Details

Calculates the Spache Formula. In contrast to readability, which by default calculates all possible indices, this function will only calculate the index value.

By default the revised Spache formula is calculated. If parameters="old", the original parameters are used.

This formula doesn't need syllable count.

Value

An object of class kRp.readability.

Examples

1
2
3
4
## Not run: 
spache(tagged.text, word.list=spache.revised.wl)

## End(Not run)

unDocUMeantIt/koRpus documentation built on May 21, 2021, 9:26 p.m.