Restructure documentation
Change-Id: I2640e68972cb7c5ed67032a3b575a2aec056f592
diff --git a/R/misc.R b/R/misc.R
index a39ef21..4529d7a 100644
--- a/R/misc.R
+++ b/R/misc.R
@@ -1,3 +1,8 @@
+#' Misc functions
+#'
+#' @name misc-functions
+NULL
+#' NULL
#' Convert corpus frequency table to instances per million.
#'
@@ -12,6 +17,7 @@
#' @return original table with additional column \code{ipm} and converted columns \code{conf.low} and \code{conf.high}
#' @export
#'
+#' @rdname misc-functions
#' @importFrom dplyr .data
#'
#' @examples
@@ -35,6 +41,7 @@
#'
#' @importFrom dplyr .data
#'
+#' @rdname misc-functions
#' @examples
#' \donttest{
#' new("KorAPConnection") %>%
@@ -58,6 +65,8 @@
#' @param excludePubDate discard publication date constraints
#' @return string or vector of strings with clipped off common prefixes and suffixes
#'
+#' @rdname misc-functions
+#'
#' @examples
#' queryStringToLabel(paste("textType = /Zeit.*/ & pubDate in", c(2010:2019)))
#' queryStringToLabel(c("[marmot/m=mood:subj]", "[marmot/m=mood:ind]"))
@@ -97,6 +106,8 @@
#' @param 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.
#' @param ... Other arguments passed to geom_ribbon, geom_line, and geom_click_point.
#'
+#' @rdname misc-functions
+#'
#' @examples
#' library(ggplot2)
#' kco <- new("KorAPConnection", verbose=TRUE)
@@ -175,6 +186,8 @@
#' \code{"url"} here.
#' @param ... Other arguments passed to \code{plotly::ggplotly}
#'
+#' @rdname misc-functions
+#'
#' @examples
#' library(ggplot2)
#' kco <- new("KorAPConnection", verbose=TRUE)