Upgrade to Roxygen 7
Change-Id: I1e31793ab7eb4c32b44522e993949a46984f7313
diff --git a/man/KorAPConnection-class.Rd b/man/KorAPConnection-class.Rd
index e13e507..08350e0 100644
--- a/man/KorAPConnection-class.Rd
+++ b/man/KorAPConnection-class.Rd
@@ -16,11 +16,17 @@
\alias{show,KorAPConnection-method}
\title{Class KorAPConnection}
\usage{
-\S4method{initialize}{KorAPConnection}(.Object,
- KorAPUrl = "https://korap.ids-mannheim.de/", apiVersion = "v1.0",
- apiUrl, apiToken = getApiToken(KorAPUrl),
- userAgent = "R-KorAP-Client", timeout = 10, verbose = FALSE,
- cache = TRUE)
+\S4method{initialize}{KorAPConnection}(
+ .Object,
+ KorAPUrl = "https://korap.ids-mannheim.de/",
+ apiVersion = "v1.0",
+ apiUrl,
+ apiToken = getApiToken(KorAPUrl),
+ userAgent = "R-KorAP-Client",
+ timeout = 10,
+ verbose = FALSE,
+ cache = TRUE
+)
\S4method{persistApiToken}{KorAPConnection}(kco, apiToken = kco@apiToken)
diff --git a/man/KorAPQuery-class.Rd b/man/KorAPQuery-class.Rd
index 7749151..17b1326 100644
--- a/man/KorAPQuery-class.Rd
+++ b/man/KorAPQuery-class.Rd
@@ -17,24 +17,41 @@
\alias{show,KorAPQuery-method}
\title{Class KorAPQuery}
\usage{
-\S4method{initialize}{KorAPQuery}(.Object, korapConnection = NULL,
- request = NULL, vc = "", totalResults = 0, nextStartIndex = 0,
- fields = c("corpusSigle", "textSigle", "pubDate", "pubPlace",
- "availability", "textClass", "snippet"), requestUrl = "",
- webUIRequestUrl = "", apiResponse = NULL, hasMoreMatches = FALSE,
- collectedMatches = NULL)
+\S4method{initialize}{KorAPQuery}(
+ .Object,
+ korapConnection = NULL,
+ request = NULL,
+ vc = "",
+ totalResults = 0,
+ nextStartIndex = 0,
+ fields = c("corpusSigle", "textSigle", "pubDate", "pubPlace", "availability",
+ "textClass", "snippet"),
+ requestUrl = "",
+ webUIRequestUrl = "",
+ apiResponse = NULL,
+ hasMoreMatches = FALSE,
+ collectedMatches = NULL
+)
-\S4method{fetchNext}{KorAPQuery}(kqo, offset = kqo@nextStartIndex,
- maxFetch = maxResultsPerPage, verbose = kqo@korapConnection@verbose)
+\S4method{fetchNext}{KorAPQuery}(
+ kqo,
+ offset = kqo@nextStartIndex,
+ maxFetch = maxResultsPerPage,
+ verbose = kqo@korapConnection@verbose
+)
-\S4method{fetchAll}{KorAPQuery}(kqo,
- verbose = kqo@korapConnection@verbose)
+\S4method{fetchAll}{KorAPQuery}(kqo, verbose = kqo@korapConnection@verbose)
-\S4method{fetchRest}{KorAPQuery}(kqo,
- verbose = kqo@korapConnection@verbose)
+\S4method{fetchRest}{KorAPQuery}(kqo, verbose = kqo@korapConnection@verbose)
-\S4method{frequencyQuery}{KorAPConnection}(kco, query, vc = "",
- conf.level = 0.95, as.alternatives = FALSE, ...)
+\S4method{frequencyQuery}{KorAPConnection}(
+ kco,
+ query,
+ vc = "",
+ conf.level = 0.95,
+ as.alternatives = FALSE,
+ ...
+)
\method{format}{KorAPQuery}(x, ...)
diff --git a/man/RKorAPClient.Rd b/man/RKorAPClient.Rd
index 06b539a..5331e5a 100644
--- a/man/RKorAPClient.Rd
+++ b/man/RKorAPClient.Rd
@@ -3,7 +3,6 @@
\docType{package}
\name{RKorAPClient}
\alias{RKorAPClient}
-\alias{RKorAPClient-package}
\title{\code{RKorapClient} package}
\description{
R pakcage to access the \href{https://github.com/KorAP/}{KorAP} web service API.
diff --git a/man/corpusQuery-KorAPConnection-method.Rd b/man/corpusQuery-KorAPConnection-method.Rd
index d527802..955cd0c 100644
--- a/man/corpusQuery-KorAPConnection-method.Rd
+++ b/man/corpusQuery-KorAPConnection-method.Rd
@@ -1,21 +1,26 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/KorAPQuery.R
-\docType{methods}
\name{corpusQuery,KorAPConnection-method}
\alias{corpusQuery,KorAPConnection-method}
\alias{corpusQuery}
\title{Method corpusQuery}
\usage{
-\S4method{corpusQuery}{KorAPConnection}(kco, query = if
- (missing(KorAPUrl))
- stop("At least one of the parameters query and KorAPUrl must be specified.",
- call. = FALSE) else httr::parse_url(KorAPUrl)$query$q, vc = if
- (missing(KorAPUrl)) "" else httr::parse_url(KorAPUrl)$query$cq, KorAPUrl,
- metadataOnly = TRUE, ql = if (missing(KorAPUrl)) "poliqarp" else
- httr::parse_url(KorAPUrl)$query$ql, fields = c("corpusSigle",
- "textSigle", "pubDate", "pubPlace", "availability", "textClass",
- "snippet"), accessRewriteFatal = TRUE, verbose = kco@verbose,
- expand = length(vc) != length(query), as.df = FALSE)
+\S4method{corpusQuery}{KorAPConnection}(
+ kco,
+ query = if (missing(KorAPUrl))
+ stop("At least one of the parameters query and KorAPUrl must be specified.", call. =
+ FALSE) else httr::parse_url(KorAPUrl)$query$q,
+ vc = if (missing(KorAPUrl)) "" else httr::parse_url(KorAPUrl)$query$cq,
+ KorAPUrl,
+ metadataOnly = TRUE,
+ ql = if (missing(KorAPUrl)) "poliqarp" else httr::parse_url(KorAPUrl)$query$ql,
+ fields = c("corpusSigle", "textSigle", "pubDate", "pubPlace", "availability",
+ "textClass", "snippet"),
+ accessRewriteFatal = TRUE,
+ verbose = kco@verbose,
+ expand = length(vc) != length(query),
+ as.df = FALSE
+)
}
\arguments{
\item{kco}{\code{\link{KorAPConnection}} object (obtained e.g. from \code{new("KorAPConnection")}}
diff --git a/man/corpusStats-KorAPConnection-method.Rd b/man/corpusStats-KorAPConnection-method.Rd
index 8a13183..6bab2cf 100644
--- a/man/corpusStats-KorAPConnection-method.Rd
+++ b/man/corpusStats-KorAPConnection-method.Rd
@@ -1,13 +1,11 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/KorAPCorpusStats.R
-\docType{methods}
\name{corpusStats,KorAPConnection-method}
\alias{corpusStats,KorAPConnection-method}
\alias{corpusStats}
\title{Fetch information about a (virtual) corpus}
\usage{
-\S4method{corpusStats}{KorAPConnection}(kco, vc = "",
- verbose = kco@verbose, as.df = FALSE)
+\S4method{corpusStats}{KorAPConnection}(kco, vc = "", verbose = kco@verbose, as.df = FALSE)
}
\arguments{
\item{kco}{\code{\link{KorAPConnection}} object (obtained e.g. from \code{new("KorAPConnection")}}
diff --git a/man/geom_freq_by_year_ci.Rd b/man/geom_freq_by_year_ci.Rd
index 74f8d40..2fe7014 100644
--- a/man/geom_freq_by_year_ci.Rd
+++ b/man/geom_freq_by_year_ci.Rd
@@ -4,8 +4,7 @@
\alias{geom_freq_by_year_ci}
\title{Experimental: Plot frequency by year graphs with confidence intervals}
\usage{
-geom_freq_by_year_ci(mapping = aes(ymin = conf.low, ymax = conf.high),
- ...)
+geom_freq_by_year_ci(mapping = aes(ymin = conf.low, ymax = conf.high), ...)
}
\arguments{
\item{mapping}{Set of aesthetic mappings created by aes() or aes_(). If specified and inherit.aes = TRUE (the default), it is combined with the default mapping at the top level of the plot. You must supply mapping if there is no plot mapping.}
diff --git a/man/ggplotly.Rd b/man/ggplotly.Rd
index 7aedff6..bd0d04b 100644
--- a/man/ggplotly.Rd
+++ b/man/ggplotly.Rd
@@ -4,8 +4,7 @@
\alias{ggplotly}
\title{Experimental: Convert ggplot2 to plotly with hyperlinks to KorAP queries}
\usage{
-ggplotly(p = ggplot2::last_plot(), tooltip = c("x", "y", "colour",
- "url"), ...)
+ggplotly(p = ggplot2::last_plot(), tooltip = c("x", "y", "colour", "url"), ...)
}
\arguments{
\item{p}{a ggplot object.}
diff --git a/man/reexports.Rd b/man/reexports.Rd
index b92085b..3bce579 100644
--- a/man/reexports.Rd
+++ b/man/reexports.Rd
@@ -22,7 +22,7 @@
\describe{
\item{broom}{\code{\link[broom]{tidy}}}
- \item{dplyr}{\code{\link[dplyr]{bind_cols}}, \code{\link[dplyr]{mutate}}, \code{\link[dplyr]{select}}, \code{\link[dplyr]{group_by}}, \code{\link[dplyr]{summarise}}}
+ \item{dplyr}{\code{\link[dplyr]{bind_cols}}, \code{\link[dplyr]{group_by}}, \code{\link[dplyr]{mutate}}, \code{\link[dplyr]{select}}, \code{\link[dplyr]{summarise}}}
\item{lubridate}{\code{\link[lubridate]{year}}}