readability,kRp.corpus-method {tm.plugin.koRpus}

Apply readability() to all texts in kRp.corpus objects

Description

This method calls readability on all tagged text objects inside the given txt.file object (using mclapply).

Usage

## S4 method for signature 'kRp.corpus'
readability(
  txt.file,
  summary = TRUE,
  mc.cores = getOption("mc.cores", 1L),
  quiet = TRUE,
  ...
)

Arguments

txt.file

An object of class kRp.corpus.

summary

Logical, determines if the summary slot should automatically be updated by calling summary on the result.

mc.cores

The number of cores to use for parallelization, see mclapply.

quiet

Logical, if FALSE shows a status bar for some calculations of each text, see readability for details.

...

options to pass through to readability.

Value

An object of the same class as txt.file.

Examples

# use readCorpus() to create an object of class kRp.corpus
# code is only run when the english language package can be loaded
if(require("koRpus.lang.en", quietly = TRUE)){
  myCorpus <- readCorpus(
    dir=file.path(path.package("tm.plugin.koRpus"), "examples", "corpus"),
    hierarchy=list(
      Topic=c(
        Winner="Reality Winner",
        Edwards="Natalie Edwards"
      ),
      Source=c(
        Wikipedia_prev="Wikipedia (old)",
        Wikipedia_new="Wikipedia (new)"
      )
    ),
    # use tokenize() so examples run without a TreeTagger installation
    tagger="tokenize",
    lang="en"
  )

  myTexts <- readability(myCorpus)
  corpusSummary(myCorpus)
} else {}