filterCharacters {DramaAnalysis}

Filter characters

Description

This function can be used to filter characters from all tables that contain a character column (and are of the class QDHasCharacter).

Usage

filterCharacters(
  hasCharacter,
  drama,
  by = c("rank", "tokens", "name"),
  n = ifelse(by == "tokens", 500, ifelse(by == "rank", 10, c()))
)

Arguments

hasCharacter

The object we want to filter.

drama

The QDDrama object.

by

Character vector. Specifies the filter mechanism.

n

The threshold or a list of character names/ids to keep.

Details

The function supports three filter mechanisms: The filter by rank sorts the characters according to the number of tokens they speak and keeps the top $n$ characters. The filter called tokens keeps all characters that speak $n$ or more tokens. The filter called name keeps the characters that are provided by name as a vector as n.

Value

The filtered QDHasCharacter object

Examples

data(rjmw.0)
dstat <- dictionaryStatistics(rjmw.0)
filterCharacters(dstat, rjmw.0, by="tokens", n=1000)