Add some documentation
Change-Id: I8ab6be53e91f7a9c289b68724c29b217f7d9007c
diff --git a/man/KorAPConnection.Rd b/man/KorAPConnection.Rd
new file mode 100644
index 0000000..451aa24
--- /dev/null
+++ b/man/KorAPConnection.Rd
@@ -0,0 +1,18 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/KorAPConnection.R
+\name{KorAPConnection}
+\alias{KorAPConnection}
+\title{\code{KorAPQuery} initiates a connect to some KorAP server.}
+\usage{
+KorAPConnection(KorAPUrl = defaultKorAPUrl, apiVersion = "v1.0",
+ apiUrl = NA)
+}
+\arguments{
+\item{KorAPUrl}{instead of providing the query and vc string parameters, you can also simply copy a KorAP query URL from your browser and use it here (and in \code{KorAPConnection}) to provide all necessary information for the query.}
+}
+\value{
+object that contains all necessary connection information and can be used on \code{\link{KorAPQuery}}
+}
+\description{
+\code{KorAPQuery} initiates a connect to some KorAP server.
+}
diff --git a/man/KorAPCorpusStats.Rd b/man/KorAPCorpusStats.Rd
new file mode 100644
index 0000000..63764ef
--- /dev/null
+++ b/man/KorAPCorpusStats.Rd
@@ -0,0 +1,18 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/KorAPCorpusStats.R
+\name{KorAPCorpusStats}
+\alias{KorAPCorpusStats}
+\title{\code{KorAPCorpusStats}}
+\usage{
+KorAPCorpusStats(con, vc = NA, query = NA)
+}
+\arguments{
+\item{con}{object obtained from \code{\link{KorAPConnection}}, that contains all necessary connection information}
+
+\item{vc}{string describing the virtual corpus. An empty string (default) means the whole corpus, as far as it is license-wise accessible.}
+
+\item{query}{qquery object returned from \code{\link{KorAPQuery}}}
+}
+\description{
+\code{KorAPCorpusStats}
+}
diff --git a/man/KorAPQuery.Rd b/man/KorAPQuery.Rd
new file mode 100644
index 0000000..725bb9c
--- /dev/null
+++ b/man/KorAPQuery.Rd
@@ -0,0 +1,36 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/KorAPQuery.R
+\name{KorAPQuery}
+\alias{KorAPQuery}
+\title{\code{KorAPQuery} perform a query on the KorAP server.}
+\usage{
+KorAPQuery(con, query = NA, vc = NA, KorAPUrl = NA,
+ metadataOnly = FALSE, ql = "poliqarp", fields = defaultFields)
+}
+\arguments{
+\item{con}{object obtained from \code{\link{KorAPConnection}}, that contains all necessary connection information}
+
+\item{query}{string that contains the corpus query. The query langauge depends on the \code{ql} parameter. Either \code{query} must be provided or \code{KorAPUrl}}
+
+\item{vc}{string describing the virtual corpus in which the query should be performed. An empty string (default) means the whole corpus, as far as it is license-wise accessible.}
+
+\item{KorAPUrl}{instead of providing the query and vc string parameters, you can also simply copy a KorAP query URL from your browser and use it here (and in \code{KorAPConnection}) to provide all necessary information for the query.}
+
+\item{ql}{string to choose the query language}
+
+\item{fields}{(meta)data fields that will be fetch for every matcch}
+
+\item{metaDataOnly}{boolean that determines wether queries should return only metadata without any snippets. This can also be useful to prevent query rewrites.}
+}
+\description{
+\code{KorAPQuery} perform a query on the KorAP server.
+}
+\examples{
+q <- KorAPQuery(con, "Ameisenplage")
+q <- KorAPQuery(KorAPConnection(), "Ameisenplage")
+q <- KorAPQuery(con, KorAPUrl = "https://korap.ids-mannheim.de/?q=Ameise&cq=pubDate+since+2017&ql=poliqarp&cutoff=1")
+
+}
+\references{
+\url{https://ids-pub.bsz-bw.de/frontdoor/index/index/docId/9026}
+}