KorAPCorpusStats: update documentation
Change-Id: I7506a029f3ded9f5fca1ea53d4eb3c465a3ede1a
diff --git a/R/KorAPCorpusStats.R b/R/KorAPCorpusStats.R
index b9e44cf..0714b28 100644
--- a/R/KorAPCorpusStats.R
+++ b/R/KorAPCorpusStats.R
@@ -1,7 +1,14 @@
#' @import jsonlite
#' @import curl
+dummy <- NA # without this roxygen2 fails
+
+#' Fetch information about a (virtual) corpus
+#' @param con object obtained from \code{\link{KorAPConnection}}
+#' @param query object returned from \code{\link{KorAPQuery}}
+#' @param vc string describing the virtual corpus. An empty string (default) means the whole corpus, as far as it is license-wise accessible.
#' @export
+#' @return object with the fields \code{$documents}, \code{$tokens}, \code{$sentences}, \code{$paragraphs}
KorAPCorpusStats <- function(con, vc = NA, query = NA) {
if ((is.na(query) && is.na(vc)) || !(is.na(query) || is.na(vc))) {
stop("Exaclty one of the parameters query and vc must be specified.")
diff --git a/man/KorAPCorpusStats.Rd b/man/KorAPCorpusStats.Rd
index 63764ef..218eb77 100644
--- a/man/KorAPCorpusStats.Rd
+++ b/man/KorAPCorpusStats.Rd
@@ -2,17 +2,20 @@
% Please edit documentation in R/KorAPCorpusStats.R
\name{KorAPCorpusStats}
\alias{KorAPCorpusStats}
-\title{\code{KorAPCorpusStats}}
+\title{Fetch information about a (virtual) corpus}
\usage{
KorAPCorpusStats(con, vc = NA, query = NA)
}
\arguments{
-\item{con}{object obtained from \code{\link{KorAPConnection}}, that contains all necessary connection information}
+\item{con}{object obtained from \code{\link{KorAPConnection}}}
\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}}}
+\item{query}{object returned from \code{\link{KorAPQuery}}}
+}
+\value{
+object with the fields \code{$documents}, \code{$tokens}, \code{$sentences}, \code{$paragraphs}
}
\description{
-\code{KorAPCorpusStats}
+Fetch information about a (virtual) corpus
}