frequencyQuery,KorAPConnection-method: Query frequencies of search expressions in virtual corpora

Description

frequencyQuery combines corpusQuery(), corpusStats() and ci() to compute a tibble with the absolute and relative frequencies and confidence intervals of one ore multiple search terms across one or multiple virtual corpora.

Usage

# S4 method for KorAPConnection
frequencyQuery(
  kco,
  query,
  vc = "",
  conf.level = 0.95,
  as.alternatives = FALSE,
  cacheAs = NULL,
  ...
)

Value

A tibble, with each row containing the following result columns for query and vc combinations:

query: the query string used for the frequency analysis.
totalResults: absolute frequency of query matches in the vc.
vc: virtual corpus used for the query.
webUIRequestUrl: URL of the corresponding web UI request with respect to query and vc.
total: total number of words in vc.
f: relative frequency of query matches in the vc.
conf.low: lower bound of the confidence interval for the relative frequency, given conf.level.
conf.high: upper bound of the confidence interval for the relative frequency, given conf.level.

Arguments

kco: KorAPConnection() object (obtained e.g. from KorAPConnection()
query: corpus query string(s.) (can be a vector). The query language depends on the ql parameter. Either query must be provided or KorAPUrl.
vc: virtual corpus definition(s) (can be a vector)
conf.level: confidence level of the returned confidence interval (passed through ci() to prop.test()).
as.alternatives: LOGICAL that specifies if the query terms should be treated as alternatives. If as.alternatives is TRUE, the sum over all query hits, instead of the respective vc token sizes is used as total for the calculation of relative frequencies.
cacheAs: path to an RDS file to keep the result in. If the file exists and records the same call, it is read back instead of contacting the server; otherwise the query is run and its result stored there. Unlike the connection's cache, this file belongs to the caller, which is what keeps an analysis reproducible once the corpus has grown or the scores have changed. Defaults to NULL (no file).
...: further arguments passed to or from other methods (see corpusQuery()), most notably expand, a logical that decides if query and vc parameters are expanded to all of their combinations. It defaults to TRUE, if query and vc have different lengths, and to FALSE otherwise.

Examples

Run this code

if (FALSE) {

KorAPConnection(verbose = TRUE) |>
  frequencyQuery(c("Mücke", "Schnake"), paste0("pubDate in ", 2000:2003))
}

Run the code above in your browser using DataLab