farr.jenkins.paterson: Readability: Farr-Jenkins-Paterson Index

Description Usage Arguments Details Value References See Also 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
farr.jenkins.paterson(
  txt.file,
  hyphen = NULL,
  parameters = c(const = -31.517, asl = 1.015, monsy = 1.599),
  ...
)

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.

hyphen

An object of class kRp.hyphen. If NULL, the text will be hyphenated automatically.

parameters

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

...

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

Details

Calculates the Farr-Jenkins-Paterson index, a simplified version of Flesch Reading Ease. In contrast to readability, which by default calculates all possible indices, this function will only calculate the index value.

If parameters="PSK", the revised parameters by Powers-Sumner-Kearl (1958) are used.

Value

An object of class kRp.readability.

References

Farr, J.N., Jenkins, J.J. & Paterson, D.G. (1951). Simplification of Flesch Reading Ease formula. Journal of Applied Psychology, 35(5), 333–337.

Powers, R.D, Sumner, W.A, & Kearl, B.E. (1958). A recalculation of four adult readability formulas, Journal of Educational Psychology, 49(2), 99–105.

See Also

flesch

Examples

1
2
3
4
## Not run: 
farr.jenkins.paterson(tagged.text)

## End(Not run)

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