Update and separate frequencyQuery documentation
Change-Id: I2fc31fd0e4d49001a739bcee63e30dac4a608e82
diff --git a/man/frequencyQuery-KorAPConnection-method.Rd b/man/frequencyQuery-KorAPConnection-method.Rd
new file mode 100644
index 0000000..9f934e6
--- /dev/null
+++ b/man/frequencyQuery-KorAPConnection-method.Rd
@@ -0,0 +1,56 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/KorAPQuery.R
+\name{frequencyQuery,KorAPConnection-method}
+\alias{frequencyQuery,KorAPConnection-method}
+\alias{frequencyQuery}
+\title{Query frequencies of search expressions in virtual corpora}
+\usage{
+\S4method{frequencyQuery}{KorAPConnection}(
+ kco,
+ query,
+ vc = "",
+ conf.level = 0.95,
+ as.alternatives = FALSE,
+ ...
+)
+}
+\arguments{
+\item{kco}{\code{\link[=KorAPConnection]{KorAPConnection()}} object (obtained e.g. from \code{KorAPConnection()}}
+
+\item{query}{corpus query string(s.) (can be a vector). The query language depends on the \code{ql} parameter. Either \code{query} must be provided or \code{KorAPUrl}.}
+
+\item{vc}{virtual corpus definition(s) (can be a vector)}
+
+\item{conf.level}{confidence level of the returned confidence interval (passed through \code{\link[=ci]{ci()}} to \code{\link[=prop.test]{prop.test()}}).}
+
+\item{as.alternatives}{LOGICAL that specifies if the query terms should be treated as alternatives. If \code{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.}
+
+\item{...}{further arguments passed to or from other methods (see \code{\link[=corpusQuery]{corpusQuery()}}), most notably \code{expand}, a logical that decides if \code{query} and \code{vc} parameters are expanded to all of their combinations. It defaults to \code{TRUE}, if \code{query} and \code{vc} have different lengths, and to \code{FALSE} otherwise.}
+}
+\value{
+A tibble, with each row containing the following result columns for query and vc combinations:
+\itemize{
+\item \strong{query}: the query string used for the frequency analysis.
+\item \strong{totalResults}: absolute frequency of query matches in the vc.
+\item \strong{vc}: virtual corpus used for the query.
+\item \strong{webUIRequestUrl}: URL of the corresponding web UI request with respect to query and vc.
+\item \strong{total}: total number of words in vc.
+\item \strong{f}: relative frequency of query matches in the vc.
+\item \strong{conf.low}: lower bound of the confidence interval for the relative frequency, given \code{conf.level}.
+\item \strong{conf.high}: upper bound of the confidence interval for the relative frequency, given \code{conf.level}.
+}
+}
+\description{
+\strong{\code{frequencyQuery}} combines \code{\link[=corpusQuery]{corpusQuery()}}, \code{\link[=corpusStats]{corpusStats()}} and
+\code{\link[=ci]{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.
+}
+\examples{
+\dontrun{
+
+KorAPConnection(verbose = TRUE) |>
+ frequencyQuery(c("Mücke", "Schnake"), paste0("pubDate in ", 2000:2003))
+}
+
+}