More documentation improvements
Change-Id: I34484d6df2e91eceb809aa97d189f8ea4918d8ea
diff --git a/NEWS.md b/NEWS.md
index 1f4e332..b859cc8 100644
--- a/NEWS.md
+++ b/NEWS.md
@@ -5,6 +5,7 @@
- hc_add_onclick_korap_search function added
- shiny web application demo added
- support for orphaned plotly package dropped
+- improved documentation structure
# RKorAPClient 0.5.9
diff --git a/R/RKorAPClient-package.R b/R/RKorAPClient-package.R
index 5c66076..d729e5e 100644
--- a/R/RKorAPClient-package.R
+++ b/R/RKorAPClient-package.R
@@ -1,5 +1,13 @@
#' @references
-#' Kupietz, Marc / Diewald, Nils / Margaretha, Eliza (2020): RKorAPClient: An R package for accessing the German Reference Corpus DeReKo via KorAP. In: Calzolari, Nicoletta, Frédéric Béchet, Philippe Blache, Khalid Choukri, Christopher Cieri, Thierry Declerck, Sara Goggi, Hitoshi Isahara, Bente Maegaard, Joseph Mariani, Hélène Mazo, Asuncion Moreno, Jan Odijk, Stelios Piperidis (eds.): [Proceedings of The 12th Language Resources and Evaluation Conference (LREC 2020)](http://www.lrec-conf.org/proceedings/lrec2020/LREC-2020.pdf). Marseille: European Language Resources Association (ELRA), 7017-7023. <http://www.lrec-conf.org/proceedings/lrec2020/pdf/2020.lrec-1.867.pdf>
+#' Kupietz, Marc / Diewald, Nils / Margaretha, Eliza (2020):
+#' RKorAPClient: An R package for accessing the German Reference Corpus DeReKo
+#' via KorAP. In: Calzolari, Nicoletta, Frédéric Béchet, Philippe Blache,
+#' Khalid Choukri, Christopher Cieri, Thierry Declerck, Sara Goggi,
+#' Hitoshi Isahara, Bente Maegaard, Joseph Mariani, Hélène Mazo,
+#' Asuncion Moreno, Jan Odijk, Stelios Piperidis (eds.):
+#' Proceedings of The 12th Language Resources and Evaluation Conference (LREC 2020)
+#' Marseille: European Language Resources Association (ELRA), 7017-7023.
+#' \url{http://www.lrec-conf.org/proceedings/lrec2020/pdf/2020.lrec-1.867.pdf}
#'
#' @keywords internal
"_PACKAGE"
diff --git a/R/association-scores.R b/R/association-scores.R
index 2d9b41e..2ab6021 100644
--- a/R/association-scores.R
+++ b/R/association-scores.R
@@ -36,6 +36,9 @@
#' @rdname association-score-functions
#'
+#' @description
+#' \bold{pmi}: pointwise mutual information
+#'
#' @export
#'
pmi <- function(O1, O2, O, N, E, window_size) {
@@ -44,6 +47,9 @@
#' @rdname association-score-functions
#'
+#' @description
+#' \bold{mi2}: pointwise mutual information squared (Daille 1994), also referred to as mutual dependency
+#' (Thanopoulos et al. 2002)
#' @export
#'
mi2 <- function(O1, O2, O, N, E, window_size) {
@@ -53,6 +59,9 @@
#' @rdname association-score-functions
#' @family association-score-functions
#'
+#' @description
+#' \bold{mi3}: pointwise mutual information cubed (Daille 1994), also referred to as log-frequency biased mutual dependency)
+#' (Thanopoulos et al. 2002)
#'
#' @export
#'
@@ -66,7 +75,9 @@
}
#' @rdname association-score-functions
-#' @family association-score-functions
+#'
+#' @description
+#' \bold{logDice}: log-Dice coefficient, a heuristic measure that is popular in lexicography (Rychlý 2008)
#' @export
#'
#' @references
@@ -81,7 +92,8 @@
#' Log likelihood
#'
#' @rdname association-score-functions
-#' @family association-score-functions
+#' @description
+#' \bold{ll}: log-likelihood (Dunning 1993) using Stefan Evert's (2004) simplified implementation
#'
#' @export
#'
@@ -91,7 +103,7 @@
#' Dunning, T. (1993): Accurate methods for the statistics of surprise and coincidence. Comput. Linguist. 19, 1 (March 1993), 61-74.
#'
#' Evert, Stefan (2004): The Statistics of Word Cooccurrences: Word Pairs and Collocations. PhD dissertation, IMS, University of Stuttgart. Published in 2005, URN urn:nbn:de:bsz:93-opus-23714.
-#' Free PDF available from <http://purl.org/stefan.evert/PUB/Evert2004phd.pdf>
+#' Free PDF available from \url{http://purl.org/stefan.evert/PUB/Evert2004phd.pdf}
#'
ll <- function(O1, O2, O, N, E, window_size) {
r1 = as.double(O1) * window_size
diff --git a/man/RKorAPClient-package.Rd b/man/RKorAPClient-package.Rd
index a93a28f..e60c721 100644
--- a/man/RKorAPClient-package.Rd
+++ b/man/RKorAPClient-package.Rd
@@ -18,7 +18,15 @@
You can learn more about 'KorAP' and use it directly on 'DeReKo' at <https://korap.ids-mannheim.de/>.
}
\references{
-Kupietz, Marc / Diewald, Nils / Margaretha, Eliza (2020): RKorAPClient: An R package for accessing the German Reference Corpus DeReKo via KorAP. In: Calzolari, Nicoletta, Frédéric Béchet, Philippe Blache, Khalid Choukri, Christopher Cieri, Thierry Declerck, Sara Goggi, Hitoshi Isahara, Bente Maegaard, Joseph Mariani, Hélène Mazo, Asuncion Moreno, Jan Odijk, Stelios Piperidis (eds.): [Proceedings of The 12th Language Resources and Evaluation Conference (LREC 2020)](http://www.lrec-conf.org/proceedings/lrec2020/LREC-2020.pdf). Marseille: European Language Resources Association (ELRA), 7017-7023. <http://www.lrec-conf.org/proceedings/lrec2020/pdf/2020.lrec-1.867.pdf>
+Kupietz, Marc / Diewald, Nils / Margaretha, Eliza (2020):
+RKorAPClient: An R package for accessing the German Reference Corpus DeReKo
+via KorAP. In: Calzolari, Nicoletta, Frédéric Béchet, Philippe Blache,
+Khalid Choukri, Christopher Cieri, Thierry Declerck, Sara Goggi,
+Hitoshi Isahara, Bente Maegaard, Joseph Mariani, Hélène Mazo,
+Asuncion Moreno, Jan Odijk, Stelios Piperidis (eds.):
+Proceedings of The 12th Language Resources and Evaluation Conference (LREC 2020)
+Marseille: European Language Resources Association (ELRA), 7017-7023.
+\url{http://www.lrec-conf.org/proceedings/lrec2020/pdf/2020.lrec-1.867.pdf}
}
\seealso{
Useful links:
diff --git a/man/association-score-functions.Rd b/man/association-score-functions.Rd
index 6591f1b..7517561 100644
--- a/man/association-score-functions.Rd
+++ b/man/association-score-functions.Rd
@@ -42,6 +42,18 @@
Functions to calculate different collocation association scores between
a node (target word) and words in a window around the it.
The functions are primarily used by \code{\link{collocationScoreQuery}}.
+
+\bold{pmi}: pointwise mutual information
+
+\bold{mi2}: pointwise mutual information squared (Daille 1994), also referred to as mutual dependency
+(Thanopoulos et al. 2002)
+
+\bold{mi3}: pointwise mutual information cubed (Daille 1994), also referred to as log-frequency biased mutual dependency)
+(Thanopoulos et al. 2002)
+
+\bold{logDice}: log-Dice coefficient, a heuristic measure that is popular in lexicography (Rychlý 2008)
+
+\bold{ll}: log-likelihood (Dunning 1993) using Stefan Evert's (2004) simplified implementation
}
\examples{
\donttest{
@@ -64,6 +76,6 @@
Dunning, T. (1993): Accurate methods for the statistics of surprise and coincidence. Comput. Linguist. 19, 1 (March 1993), 61-74.
Evert, Stefan (2004): The Statistics of Word Cooccurrences: Word Pairs and Collocations. PhD dissertation, IMS, University of Stuttgart. Published in 2005, URN urn:nbn:de:bsz:93-opus-23714.
-Free PDF available from <http://purl.org/stefan.evert/PUB/Evert2004phd.pdf>
+Free PDF available from \url{http://purl.org/stefan.evert/PUB/Evert2004phd.pdf}
}
\concept{association-score-functions}