strain {koRpus}

Readability: Strain Index

Description

This is just a convenient wrapper function for readability.

Usage

strain(txt.file, hyphen = NULL, parameters = c(sent = 3, const = 10), ...)

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.

...

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

Details

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

Value

An object of class kRp.readability.

Examples

## Not run: 
strain(tagged.text)

## End(Not run)