Improve documentation of span parameter in ca
Change-Id: I35cf877fb04701c989fe5ef81a7cd262b9bc30e3
diff --git a/R/collocationAnalysis.R b/R/collocationAnalysis.R
index fc96f1c..b79a2b3 100644
--- a/R/collocationAnalysis.R
+++ b/R/collocationAnalysis.R
@@ -31,6 +31,7 @@
#' @param topCollocatesLimit limit analysis to the n most frequent collocates in the search hits sample
#' @param searchHitsSampleLimit limit the size of the search hits sample
#' @param stopwords vector of stopwords not to be considered as collocates
+#' @param withinSpan KorAP span specification (see <https://korap.ids-mannheim.de/doc/ql/poliqarp-plus?embedded=true#spans>) for collocations to be searched within. Defaults to `base/s=s`.
#' @param exactFrequencies if FALSE, extrapolate observed co-occurrence frequencies from frequencies in search hits sample, otherwise retrieve exact co-occurrence frequencies
#' @param seed seed for random page collecting order
#' @param expand if TRUE, `node` and `vc` parameters are expanded to all of their combinations
diff --git a/R/collocationScoreQuery.R b/R/collocationScoreQuery.R
index cf05540..85c65a5 100644
--- a/R/collocationScoreQuery.R
+++ b/R/collocationScoreQuery.R
@@ -24,7 +24,7 @@
#' @param smoothingConstant smoothing constant will be added to all observed values
#' @param observed if collocation frequencies are already known (or estimated from a sample) they can be passed as a vector here, otherwise: NA
#' @param ignoreCollocateCase logical, set to TRUE if collocate case should be ignored
-#' @param withinSpan KorAP span specification for collocations to be searched within
+#' @param withinSpan KorAP span specification (see <https://korap.ids-mannheim.de/doc/ql/poliqarp-plus?embedded=true#spans>) for collocations to be searched within. Defaults to `base/s=s`.
#'
#' @return tibble with query KorAP web request URL, all observed values and association scores
#'