FORCAST: Readability: FORCAST Index

Description Usage Arguments Details Value References 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
FORCAST(
  txt.file,
  hyphen = NULL,
  parameters = c(syll = 1, mult = 0.1, const = 20),
  ...
)

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 "RGL".

...

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

Details

Calculates the FORCAST index (both grade level and reading age). In contrast to readability, which by default calculates all possible indices, this function will only calculate the index value.

If parameters="RGL", the parameters for the precise Reading Grade Level are used.

Value

An object of class kRp.readability.

References

Klare, G.R. (1975). Assessing readability. Reading Research Quarterly, 10(1), 62–102.

Examples

1
2
3
4
## Not run: 
FORCAST(tagged.text)

## End(Not run)

koRpus documentation built on May 18, 2021, 1:13 a.m.