Merge remote-tracking branch 'origin/highcharter'
Change-Id: I98105c0315fc224838162774a6620d8e30263e68
diff --git a/man/figures/Readme-Example-2.png b/man/figures/Readme-Example-2.png
new file mode 100644
index 0000000..3a9ed19
--- /dev/null
+++ b/man/figures/Readme-Example-2.png
Binary files differ
diff --git a/man/hc_freq_by_year_ci.Rd b/man/hc_freq_by_year_ci.Rd
new file mode 100644
index 0000000..8daa145
--- /dev/null
+++ b/man/hc_freq_by_year_ci.Rd
@@ -0,0 +1,43 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/highcharter-helper.R
+\name{hc_freq_by_year_ci}
+\alias{hc_freq_by_year_ci}
+\title{Experimental: Plot interactive frequency by year graphs with confidence intervals using highcharter}
+\usage{
+hc_freq_by_year_ci(
+ df,
+ as.alternatives = F,
+ ylabel = if (as.alternatives) "\%" else "ipm"
+)
+}
+\arguments{
+\item{df}{data frame like the value of a \code{\link{frequencyQuery}}}
+
+\item{as.alternatives}{boolean decides whether queries should be treatet queries as mutually exclusive and exahustive wrt. to some meaningful class (e.g. spelling variants of a certain word form).}
+
+\item{ylabel}{defaults to \% if \code{as.alternatives} is \code{true} and to "ipm" otherwise.}
+}
+\description{
+Experimental convenience function for plotting typical frequency by year graphs with confidence intervals using highcharter.
+\bold{Warning:} This function may be moved to a new package.
+}
+\examples{
+new("KorAPConnection", verbose = TRUE) \%>\%
+ frequencyQuery(query = c("macht []{0,3} Sinn", "ergibt []{0,3} Sinn"),
+ vc = paste("textType = /Zeit.*/ & pubDate in", c(2010:2014)),
+ as.alternatives = TRUE) \%>\%
+ hc_freq_by_year_ci(as.alternatives = TRUE)
+
+kco <- new("KorAPConnection", verbose = TRUE)
+expand_grid(
+ condition = c("textDomain = /Wirtschaft.*/", "textDomain != /Wirtschaft.*/"),
+ year = (2005:2011)
+) \%>\%
+ cbind(frequencyQuery(
+ kco,
+ "[tt/l=Heuschrecke]",
+ paste0(.$condition, " & pubDate in ", .$year)
+ )) \%>\%
+ hc_freq_by_year_ci()
+
+}
